v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Issue Collect Request

post/v3/payments/upi/collect

Headers

client_idstring required

Decentro assigned client_id during on boarding.

client_secretstring required

Decentro assigned client_secret during on boarding.

x_on_behalf_ofstring

This allows parent merchant to consume the API on behalf of sub-merchant.

x_device_osstring

The the device and browser type of the payer. Possible values - android_mobile, ios_mobile, desktop_web

authorizationstring

Customers can generate JWT using our Auth API with various grant types in the request body. JWT is valid for 15minutes.

Request body

reference_idstring required

A unique ID assigned by the user for this transaction.

consumer_urnstring required

A unique identifier assigned to client's by Decentro during On boarding.

amountinteger required

The transaction amount you want to collect. Min = 5.00 and MAX = 100000.00. The limits on the amount can be changed depending on merchant use case. Please contact support@decentro.tech for further assistance.

purpose_messagestring

The narration that you want to show as a message for the transfer. (Note: Purpose message must be less than 50 characters).

expiry_timeinteger required

payer_namestring required

Name of the Payer, I.E., the end customer associated with the UPI VPA.

payer_vpastring required

UPI VPA/ID of the payer.

account_numberstring

Used for TPV. The number of the source bank account from which the payment must be made. Payments from any other account (mapped to the UPI ID) will be rejected.

account_ifscstring

Used for TPV. The IFSC number of the source bank account from which the payment must be made. Payments from any other account (mapped to the UPI ID) will be rejected.

split_settlement_rule_urnstring

This param will help us to identify the split settlement rule at transaction level.

Response

200

decentro_txn_idstring

api_statusstring

messagestring

response_keystring

Example response

{
  "decentro_txn_id": "B8C9C661C92443D09C1506F0A02DB6DE",
  "api_status": "SUCCESS",
  "message": "Collection request created successfully.",
  "data": {
    "transaction_status": "PENDING",
    "bank_reference_number": "XXXXX"
  },
  "response_key": "success_payment_collect_request_created"
}