post https://api.juspay.in/txns#UPICollectTPV
Create a collect transaction for given VPA with Third-Party Validation (TPV). In a UPI collect transaction, payment collect request is sent to the UPI app.
The payment_method attribute must be one from this table:
(click to open table)
(click to open table)
| Bank Code (payment_method) | Bank Name |
|---|---|
| JP_ANDHRA | Andhra Bank |
| JP_AXIS | Axis Bank |
| JP_CANR | Canara Bank |
| JP_ICICI | ICICI Bank |
| JP_IOB | Indian Overseas Bank |
| JP_KVB | Karur Vysya Bank |
| JP_PNB | Punjab National Bank |
| JP_SBI | State Bank of India |
| JP_IDFC | IDFC Bank |
| JP_HDFC | HDFC Bank |
| JP_YESB | Yes Bank |
| JP_DLS | Dhanalaxmi Bank |
| JP_CSB | Catholic Syrian Bank |
| JP_OBC | Oriental Bank Of Commerce |
| JP_LVB | Lakshmi Vilas Bank Retail |
| PAY | UPI Intent Payment |
| COLLECT | UPI Collect Payment |
| INAPP | UPI IN App Payment |
The response for the UPI Collect Payment API is a Payment Status Object (click to open table)
| Parameter | Type | Description |
|---|---|---|
| order_id | String | Unique Identifier for the order. |
| txn_id | String | Transaction ID for the payment attempt. |
| status | String | Status of the transaction. See Appendix below for status mapping. PENDING_VBV indicates that the transaction requires authentication to complete. |
| payment.authentication.method | String | HTTP Method for authentication. Can be one of GET or POST (See redirection instructions in the "Handling the Redirection Method" section above.) |
| payment.authentication.url | String | URL to which the user has to be taken to for completing the authentication |
| payment.authentication.params | Object | Present only when the method is POST. This a mapping via a list of key:value pairs that must be sent along with the URL for authentication. Do not hardcode the params in your client * Never assume that you will receive param “x” or param “y”. This is completely dynamic and will vary on a case by case basis. |
| Status | ID | Meaning |
|---|---|---|
| NEW | 10 | Newly created order |
| PENDING_VBV | 23 | Authentication is in progress |
| CHARGED | 21 | Successful transaction |
| AUTHENTICATION_FAILED | 26 | User did not complete authentication |
| AUTHORIZATION_FAILED | 27 | User completed authentication, but bank refused the transaction |
| JUSPAY_DECLINED | 22 | User input is not accepted by the underlying PG |
| AUTHORIZING | 28 | Transaction status is pending from bank |
The request consists of Payment Method Details and two extra parameters: txn_type (must be set to 'UPI_COLLECT'), and upi_vpa (VPA of customer) Parameters are listed below:
⭣
Note:
Since VPA is a mandatory request parameter, merchants are advised to use the Verify VPA API to check if the VPA is valid or not.