Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

UPI Collect Payment

Create a collect transaction for given VPA. In UPI collect transaction, payment collect request is sent to the UPI app.

The response for the UPI Collect Payment API is a Payment Status Object       (click to open table)
ParameterTypeDescription
order_idStringUnique Identifier for the order.
txn_idStringTransaction ID for the payment attempt.
statusStringStatus of the transaction. See Appendix below for status mapping. PENDING_VBV indicates that the transaction requires authentication to complete.
payment.authentication.methodStringHTTP Method for authentication. Can be one of GET or POST (See redirection instructions in the "Handling the Redirection Method" section above.)
payment.authentication.urlStringURL to which the user has to be taken to for completing the authentication
payment.authentication.paramsObjectPresent 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.
  APPENDIX   - Payment status codes and meaning:
StatusIDMeaning
NEW10Newly created order
PENDING_VBV23Authentication is in progress
CHARGED21Successful transaction
AUTHENTICATION_FAILED26User did not complete authentication
AUTHORIZATION_FAILED27User completed authentication, but bank refused the transaction
JUSPAY_DECLINED22User input is not accepted by the underlying PG
AUTHORIZING28Transaction 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 (described here) to check if the VPA is valid or not.

Note:
If using the Third-Party Validation (TPV) option, payment_method must be one from this table: (click to open)
Bank Code (payment_method)Bank Name
JP_ANDHRAAndhra Bank
JP_AXISAxis Bank
JP_CANRCanara Bank
JP_ICICIICICI Bank
JP_IOBIndian Overseas Bank
JP_KVBKarur Vysya Bank
JP_PNBPunjab National Bank
JP_SBIState Bank of India
JP_IDFCIDFC Bank
JP_HDFCHDFC Bank
JP_YESBYes Bank
JP_DLSDhanalaxmi Bank
JP_CSBCatholic Syrian Bank
JP_OBCOriental Bank Of Commerce
JP_LVBLakshmi Vilas Bank Retail
PAYUPI Intent Payment
COLLECTUPI Collect Payment
INAPPUPI IN App Payment
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!