API Docs

Create UPI Collect Request

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

Use this API to create a UPI collect request.

Path Params
string
required

Only accounts with a VPA are accepted.

Unique identifier of the account to which money should be credited.

Example: va_MDOShxKdcWpm7vEr2yDVb88EP

Body Params
string
required

The vpa handle to which the collect request should be sent.

When the collect request is authorized, money is debited from the account linked to this VPA.

Example: anil-reddy@example

float
required

The amount you want to collect.

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

int32
required

Time in minutes after which the request expires.
Example: 10

string
required

The remark you want to show in the UPI collect request.

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

string
required

Unique identifier entered when creating the collect request.

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

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 about 2 years ago

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