UPI Collect

post

https://example.com/paymentGateway/v1/upiCollect

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Schema for initiating a UPI collect transaction

userRef

string

required

Internal reference ID for the user or transaction

amount

string

required

Transaction amount in string format (e.g., '10')

vpa

string

required

Virtual Payment Address (e.g., 1234567890@upi)

firstName

string

required

First name of the payer

lastName

string

Last name of the payer (optional)

productInfo

string

required

Short description or name of the product/service

phone

string

required

Payer's mobile number

string

required

Payer's email address

udf1

string

User-defined field 1 (optional metadata)

udf2

string

User-defined field 2 (optional metadata)

udf3

string

User-defined field 3 (optional metadata)

udf4

string

User-defined field 4 (optional metadata)

udf5

string

User-defined field 5 (optional metadata)

successRedirectUrl

string

required

URL to redirect the user on successful transaction

failedRedirectUrl

string

required

URL to redirect the user on failed transaction

deviceInfo

string

required

Device or platform information (e.g., Android, iOS)

string

required

IP address of the end-user initiating the collect request

latitude

string

required

Latitude of the end-user's current location

longitude

string

required

Longitude of the end-user's current location

Headers

X-Breden-Token

string

X-Breden-Key

string

X-Breden-CropCode

string

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200