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

SendMoney

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.

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

                      x-merchant-id
                      *
                      

string

Required

Will be shared while onboarding.

                      x-merchant-channel-id
                      *
                      

string

Required

Will be shared while onboarding.

                      x-timestamp
                      *
                      

string

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.

                      content-type	
                      *
                      

String

Required

application/json

                      accept	
                      *
                      

String

Required

application/json

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

                      bankAccountUniqueId
                      *
                      

String

Mandatory

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

                      upiRequestId
                      *
                      

String

Mandatory

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

                      payerVpa
                      *
                      

String

Mandatory

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

                      remarks
                      *
                      

String

Mandatory

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

                      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

                      transactionType
                      *
                      

String

Mandatory

Type of payment
Constraints:P2M_PAY, P2P_PAY, INTENT_PAY or SCAN_PAY

                      payeeBankAccountUniqueId
                      
                      

String

optional

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

                      currency
                      *
                      

String

Mandatory

Currency code
Constraints:String - INR

                      purpose
                      *
                      

String

Mandatory

Defines the purpose code of the transaction

                      credBlock
                      *
                      

String

Mandatory

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

                      amount
                      *
                      

String

Mandatory

Amount for transaction
Constraints:Numeric string with two decimals

                      udfParameters
                      
                      

JSON String

Optional

Stringified JSON for udf parameters

                      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)

mcc

String

Optional

Merchant category code

                      initiationMode
                      
                      

String

Optional

Defines the initiation mode of the transaction

                      upiNumber
                      
                      

String

UPI Mapper

upiNumber of payee if transaction is done using UPI Number
Constraint : 8-10 digit Number

lrn

String

UPI Lite

Lite Reference Number which is reference the number provided for the wallet linked with account number. This field is Mandatory for UPI Lite

                      timestamp
                      
                      

String

UPI Lite

This is the timestamp in GMT format which was sent to CL for generating ARQC credblock. This timestamp should be passed as it is which was passed to CL. This field is Mandatory for UPI Lite

                      baseAmount
                      
                      

String

UPI International

Amount in base currency

                      baseCurr
                      
                      

String

UPI International

Base currency

                      intlTxnConsent
                      
                      

String

UPI International

The consent type denotes the purpose for which the customer’s consent is being taken.This is for specific use cases as may be defined in future. This tag is not applicable for GST

                      originalTransactionUpiRequestId	
                      
                      

String

UPI International

The txnId of QR Validation request

                      clVersion
                      
                      

String

Optional

Common Library Version of the UPI application clVersion
Constraints: Common Library Version of the UPI application (Mandatory for BioAuth payments)

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
Values: something@handle

                      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

Response status returned by gateway
Values: SUCCESS, FAILURE

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Reference id returned by the gateway

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message for code returned by gateway

                      gatewayPayerResponseCode
                      
                      

String

optional

Response code returned by gateway

                      gatewayPayeeResponseCode
                      
                      

String

Optional

Response code returned by gateway

                      gatewayPayerReversalResponseCode
                      
                      

String

optional

Response code returned by gateway

                      gatewayPayeeReversalResponseCode
                      
                      

String

optional

Response code returned by gateway

                      payeeActype
                      *
                      

String

Mandatory

Account type of the customer who received the payment

                      payeeIfsc
                      *
                      

String

Mandatory

Account's ifsc of the customer who received the payment

                      payerActype
                      *
                      

String

Mandatory

Account type of the customer who received the payment

                      payerIfsc
                      *
                      

String

Mandatory

Account type of the customer who received the payment

                      arpc
                      
                      

String

UPI Lite

This comes from NPCI for all lite txns and it needs to be passed to CL. Only in Successful Response of UPI Lite

                      udfParameters
                      
                      

JSON String

Optional

Udf parameters as passed in the request

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