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

Send Money (International)

This api will be used for completing all P2P and P2M Payment scenarios. This includes

Incoming Intent Payment
Scan and Pay (UPI QR & Bharat QR)
P2P Pay (Vpa & Account+IFSC)
Payment to PSP merchant
Self Pay

The api can be invoked to process different types of payments. The transactionType key of request is used to identify the type of payment. Possible values are P2M_PAY, P2P_PAY, SELF_PAY, INTENT_PAY and SCAN_PAY. Depending on the payment type, some additional parameters need to be passed.

P2M_PAY is to be used for payment to a PSP merchant only. The payeeVpa should be a valid PSP generated vpa for the merchant.

INTENT_PAY and SCAN_PAY are used for the intent and qr scan transactions. Both UPI QR and Bharat QR codes are supported.

P2P_PAY is to be used for completing all other P2P payment scenarios. For direct to account transfers, payeeVpa should be of format <account-no>@<ifsc-code>.ifsc.npci like 12345@BankIFSC.ifsc.npci.

SELF_PAY is to be used for doing a self transfer between customer accounts having same vpa domain.

UPI International transactionType will only be SCAN_PAY.

Below are some request parameters required to be handled specifically according to the payment scenario.

Request

Response

API Endpoints

Production Link

POST

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

                      Content-Type
                      *
                      

string

Required

application/json

                      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
                      *
                      

integer

Required

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

                      x-merchant-signature
                      *
                      

string

Required

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

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

                      payerVpa
                      *
                      

String

Mandatory

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

                      payeeVpa
                      *
                      

String

Mandatory

Vpa of the payee to whom money is being sent
Constraints:something@handle

                      payeeName
                      
                      

String

optional

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

                      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 payer selected bank account
Constraints: bankAccountUniqueId in the response of Fetch Accounts api call

                      credBlock
                      *
                      

String

Mandatory

Encrypted credblock containing user mpin
Constraints:As returned by Common Library

                      remarks
                      *
                      

String

Mandatory

Any transaction summary
Constraints:50 characters, alphanumeric, space and hyphen

                      currency
                      *
                      

String

Mandatory

Currency code
Constraints:String - INR

                      transactionType
                      *
                      

String

Mandatory

Type of payment
Constraints:SCAN_PAY

                      transactionReference
                      
                      

String

optional

Transaction reference id

                      refUrl
                      
                      

String

optional

Reference url for the intent transaction

                      refCategory
                      
                      

String

optional

Details for refUrl, whether it is 01 (Advertisement), 02(Invoice)

                      udfParameters
                      
                      

String

optional

Stringified JSON for udf parameters

mcc

String

optional

Merchant category code

                      payeeBankAccountUniqueId
                      
                      

String

Optional

Unique id for the payee selected bank account for self transferbankAccountUniqueId in the response of Fetch Accounts api call

                      initiationMode
                      
                      

String

optional

Defines the initiation mode of the transaction

                      purpose
                      
                      

String

optional

Defines the purpose code of the transaction

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

                      payerVpa
                      *
                      

String

Mandatory

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

                      payeeMcc
                      *
                      

String

Mandatory

MCC for the payee

                      payeeMerchantCustomerId
                      
                      

String

optional

Merchant generated unique id for customer who received the payment. Only if it is an onus P2P transaction.

                      payeeName
                      
                      

String

Optional

Name of the upi user who received the payment. Only if payment is done to a non A/C+IFSC vpa.

                      payeeVpa
                      *
                      

String

Mandatory

Vpa of the upi user who received the payment

                      payeeActype
                      *
                      

String

Mandatory

Account type of the customer who received the payment

                      payerActype
                      *
                      

String

Mandatory

Account type of the customer who sends the payment

                      payeeIfsc
                      *
                      

String

Mandatory

Account ifsc of the customer who received the payment

                      payerIfsc
                      *
                      

String

Mandatory

Account ifsc of the customer who sends the payment

                      refUrl
                      *
                      

String

Mandatory

Reference url for the intent transaction

                      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

                      amount
                      *
                      

String

Mandatory

Amount for the payment

Values: As passed in the request

                      transactionType
                      *
                      

String

Mandatory

Type of payment

Values: As sent in request

                      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

                      gatewayPayerResponseCode
                      *
                      

String

Mandatory

                      gatewayPayeeResponseCode
                      
                      

String

optional

Response code returned by gateway

                      gatewayPayerReversalResponseCode
                      
                      

String

Optional

Response code returned by gateway

                      gatewayPayeeReversalResponseCode
                      
                      

String

Optional

Response code returned by gateway

                      udfParameters
                      
                      

JSON String

Optional

Udf parameters as passed in the request