API Docs

Create First Funding UPI Collect Request

post
https://api.zwitch.io/v1/accounts//payments/upi/collect

Use this API to create a first funding UPI collect request.

📘

Note

  • You can only create fIrst funding UPI collect requests for accounts with the status active. The UPI collect request will not be created if the account has any other status.

  • You need the unique identifier of your virtual receivable account to create a first funding UPI collect request. This account is created by us and the details are sent to you via email. Contact our Integration Team if you have not received these details.

Path Params
string
required

Unique identifier of your funding receivable account in the ZWITCH database.

Example: va_nk1Tqog2Je5uawOn3veb3oFs3

Note: Contact our Integrations Team if you have not received details of this account.

Body Params
string
required

The type of payments you want to receive.

Possible value: funding

string
required

Unique identifier of the account you want to fund.

Example: sa_Ov7T4kb7SiRTuTELfq0BZNxcP

string
required

Unique identifier obtained when verifying the applicant's UPI ID.

Example: accver_mtBP3HwL4JE6Ywl2oL2wiun09

Use our VPA Verification API to verify the applicant's UPI ID.

float
required

Funding amount

  • Minimum value: 1.00 (₹1)
  • Maximum value: 100000.00 (₹1 Lakh)
Example: 3.69

int32
required

Time in minutes after which the UPI collect request expires.

Example: 10

string
required

Unique identifier entered by you when creating the request.

  • Only alphabets and numbers are allowed.
  • Minimum: 7 characters.
  • Maximum: 40 characters.
Example: 1409614085

string
required

The remark to be shown in the UPI collect request.

  • Only alphabets, numbers, and space are allowed.
  • Minimum: 1 character.
  • Maximum: 50 characters.
Example: Zwitch for the win.

metadata
object

Key-value pair that can be used to store additional information about the entity.

  • Each pair cannot exceed 256 characters.
  • Maximum 5 key-value pairs.
Example: "key_1": "DD”

Responses

Updated 9 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago