JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Request Money

This api can be used to request money from another VPA.

Note

Validity of a payerVpa can be verified using the Verify VPA API.
SERVICE_UNAVAILABLE_{entity}_{error} will be returned in case of NPCI timeout.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/transactions/requestMoney

                      Content-Type
                      *
                      

string

Required

application/json

                      x-merchant-signature
                      *
                      

string

Required

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

                      x-merchant-id
                      *
                      

string

Required

Will be shared while onboarding.

                      x-merchant-channel-id
                      *
                      

string

Required

Will be shared while onboarding.

                      Accept
                      *
                      

string

Required

application/json

                      x-timestamp
                      *
                      

string

Required

This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.

Body

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer
Constraints: Alphanumeric string with dot(.). Maximum length is 256.

                      deviceFingerPrint
                      *
                      

String

Mandatory

Device fingerprint of the customer

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated id for the transaction
Constraints: 35 characters alphanumeric

                      payeeVpa
                      *
                      

String

Mandatory

VPA of the customer to be used for payment
Constraints: something@handle

                      payerVpa
                      *
                      

String

Mandatory

Vpa of the payer to which collect request is to be sent
Constraints: something@handle

                      payerName
                      *
                      

String

Mandatory

Name of the payer
Constraints: String as returned in the Verify VPA API

                      collectRequestExpiryMinutes
                      *
                      

String

Mandatory

Minutes for which the collect request is valid
Constraints: A numeric string between 1 to 64800 (both inclusive)

                      amount
                      *
                      

String

Mandatory

Amount for transaction
Constraints: Numeric string with two decimals

                      upiRequestId
                      *
                      

String

Mandatory

Unique id sent to UPI switch for the request
Constraints: 35 character alphanumeric. Should always start with merchant prefix provided.

                      bankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the selected bank account
Constraints: bankAccountUniqueId in the response of Fetch Accounts api call

                      remarks
                      *
                      

String

Mandatory

Any transaction summary 50 characters, alphanumeric, space and hyphen

                      currency
                      *
                      

String

Mandatory

Currency code
Constraints: String - INR

                      udfParameters
                      
                      

String

optional

Stringified JSON for udf parameters

                      initiationMode
                      
                      

String

optional

Defines the initiation mode of the transaction

                      purpose
                      
                      

String

optional

Defines the purpose code of the transaction

                      upiNumber
                      
                      

String

optional

upiNumber of payer if transaction is done using UPI Number
Constraints: String (8-10 digit Number)

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API
Values: SUCCESS, FAILURE

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API
Values: Refer error code section

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API
Values: Refer error code section

                      payload
                      *
                      

JSON

Mandatory

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant as passed in request headers

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the merchant channel as passed in request headers

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer as passed in the request

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated id for the transaction
Values: As passed in the request

                      customerMobileNumber
                      *
                      

String

Mandatory

Customer mobile number
Values: 12 digits mobile number string

                      amount
                      *
                      

String

Mandatory

Amount for transaction
Values: As passed in the request

                      expiryTimestamp
                      *
                      

String

Mandatory

Timestamp of when the collect request will expire
Values: YYYY-MM-DDTHH:MM:SS+05:30

                      payeeVpa
                      *
                      

String

Mandatory

Customer vpa used for the payment
Values: As passed in the request

                      payeeMcc
                      *
                      

String

Mandatory

MCC for the payee

                      payerVpa
                      *
                      

String

Mandatory

Vpa of the UPI user who received the collect request
Values: something@handle

                      payerName
                      *
                      

String

Mandatory

Name of the payer to whom collect request was sent

                      refUrl
                      *
                      

String

Mandatory

Reference url for the intent transaction

                      remarks
                      *
                      

String

Mandatory

Remarks sent by customer for the collect request

                      bankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the selected bank account
Values: As passed in the request

                      bankCode
                      *
                      

String

Mandatory

Bank code of the account which was used
Values: Valid bank IIN

                      maskedAccountNumber
                      *
                      

String

Mandatory

Masked account number of the account which was used
Values: XXXX123456

                      transactionTimestamp
                      *
                      

String

Mandatory

Timestamp of when the transaction was attempted
Values: YYYY-MM-DDTHH:MM:SS+05:30

                      gatewayTransactionId
                      *
                      

String

Mandatory

Transaction id returned by gateway

                      gatewayReferenceId
                      *
                      

String

Mandatory

Reference id returned by the gateway

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway
Values: SUCCESS, FAILURE

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message for code returned by gateway

                      udfParameters
                      
                      

json String

optional

Udf parameters as passed in the request

Have questions?
Need help? Contact support
LLM? Read llms.txt