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

Initial Top Up

This API will be used for initial topup of UPI wallet

Value of Payer and Payee Vpa will be same.
timestamp should be passed by merchant which should be same which was given to CL.

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
                      *
                      

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.

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 customer adding money.

                      payeeVpa
                      *
                      

String

Mandatory

Vpa of customer adding money.

                      payeeName
                      
                      

String

Optional

Name of the payee

Constraints:String as returned in the Verify VPA API

                      amount
                      *
                      

String

Mandatory

Amount for the payment

Constraints:As passed in the request

                      upiRequestId
                      *
                      

String

Mandatory

Unique request id passed to UPI switch

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 and arqccred

Constraints:As returned by Common Library

                      remarks
                      *
                      

String

Mandatory

Any transaction summary

Constraints:62 characters alphanumeric with hyphen

                      currency
                      *
                      

String

Mandatory

Currency code

Constraints:String - INR

                      transactionType
                      *
                      

String

Mandatory

Type of payment

Constraints:P2P_PAY

                      transactionReference
                      
                      

String

optional

Transaction reference id

Constraints:String

                      refUrl
                      
                      

String

optional

Reference url for the intent transaction

Constraints:String

                      refCategory
                      
                      

String

optional

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

Constraints:String

mcc

String

optional

Merchant category code

Constraints:String

                      initiationMode
                      
                      

String

optional

Defines the initiation mode of the transaction

Constraints:InitiationModes

                      purpose
                      
                      

String

optional

Defines the purpose code of the transaction

Constraints: Purpose codes

                      udfParameters
                      
                      

Json String

optional

Udf parameters as passed in the request

Constraints:JSON string

                      ifsc
                      *
                      

String

Mandatory

Ifsc for the bank account as returned by NPCI

Constraints:String

                      lrn	
                      *
                      

String

Mandatory

Lite Reference Number which is reference the number provided for the wallet linked with account number

Constraints:String

                      timestamp
                      *
                      

String

Mandatory

This is the timestamp in ISO format which was sent to CL for generating ARQC credblock. This timestamp should be passed as it is which was passed to CL

Constraints:String

                      packageName
                      *
                      

String

Mandatory

Package name of the UPI application

Constraints:String

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

                      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

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated id for the transaction

Values:As passed in the request

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer 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

                      Reference url for the intent transaction	
                      *
                      

String

Mandatory

                      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

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway

Values:SUCCESS, FAILURE

                      gatewayReferenceId
                      *
                      

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

                      riskScore
                      
                      

String

optional

RiskScore shared by NPCI or Bank

                      arpc
                      *
                      

String

Mandatory

This comes from NPCI for all lite txns and it needs to be passed to CL

                      udfParameters
                      
                      

json String

optional

Udf parameters as passed in the request

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