Body
UPI Collect
Create a collect transaction for given UPI VPA. In UPI collect transaction, payment collect request is sent to the UPI app.
Note
Please use the relevant parameters received from the Payment Method API in UPIfor payment_method_type and payment_method fields.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/txns
Production Link
POST
https://api.juspay.in/txns
Headers
Content-Type
*
String
Mandatory
application/x-www-form-urlencoded
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Parameters
order_id
*
string
Mandatory
order_id pertaining to the order for which the payment is started.
merchant_id
*
string
Mandatory
ID of the merchant_account that you hold with us.
payment_method_type
*
string
Mandatory
Must be UPI
payment_method
*
string
Mandatory
Please use the relevant value received from the Payment Method API in thepayment_method field.
txn_type
*
string
Mandatory
Must be UPI_COLLECT for Old UPI Collect Request. This field is obsolete for New UPI Collect Request
upi_vpa
*
string
Mandatory
VPA to which the collect request must be sent.
format
*
string
Mandatory
If it is set to json, then the response will be HTTP 200 with a JSON formatted text. Otherwise, the response is HTTP 302 with the Location attribute having the destination URL.
redirect_after_payment
*
string
Mandatory
This is a boolean variable and accepts true/false. We recommend that you set this to true and use the redirection flow. If set to true, then the user is redirected to the return_url configured for the order. If set to false, then the user will be stopped at the response page from the gateway. Your client should be able to read the page/title to infer that the user has completed the transaction.
200 : Success
Response Body
order_id
string
test_9069_789
txn_id
string
aman_prod-test_9069_789-9
txn_uuid
string
dev8pyieixvdyldt
status
string
PENDING_VBV
payment
object
authentication.method
string
authentication.url
String
400 : Invalid Input data
Response Body
object
object
{}