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

QR Validation

This API is used to validate the UPI international QR, and before doing any payment, This api should be done.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/international/validateQr

                      content-type	
                      *
                      

String

Mandatory

application/json

                      accept
                      *
                      

String

Mandatory

application/json

                      x-merchant-id	
                      *
                      

String

Mandatory

Will be shared while onboarding.

                      x-merchant-channel-id	
                      *
                      

String

Mandatory

Will be shared while onboarding.

                      x-timestamp	
                      *
                      

String

Mandatory

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

                      x-merchant-signature	
                      *
                      

String

Mandatory

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

                      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

                      upiRequestId
                      *
                      

String

Mandatory

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

                      qrPayLoad
                      *
                      

String

Mandatory

Deep Link URL

                      initiationMode
                      *
                      

String

Mandatory

Defines the initiation mode of the transaction

                      networkInstitutionId
                      
                      

String

optional

Unique ID for each international institution provided by UPI

                      udfParameters
                      
                      

JSON String

optional

Stringified JSON for udf parameters

Body

Request Schema: application/json

                      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

                      upiRequestId
                      *
                      

String

Mandatory

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

                      qrPayLoad
                      *
                      

String

Mandatory

Deep Link URL

                      initiationMode
                      *
                      

String

Mandatory

Defines the initiation mode of the transaction

                      networkInstitutionId
                      
                      

String

Optional

Unique ID for each international institution provided by UPI

                      udfParameters
                      
                      

JSON String

Optional

Stringified JSON for udf parameters

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

                      udfParameters
                      
                      

JSON String

Optional

Udf parameters as passed in the request

                      payload
                      *
                      

String

Mandatory

                      txnId
                      *
                      

String

Mandatory

This id will be created for every txn by Merchant

                      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

                      paymentDetails
                      *
                      

String

Mandatory

                      payeeName
                      *
                      

String

Mandatory

Payee name is to be used for International Pay txns

                      payeeCode
                      *
                      

String

Mandatory

MCC code of payee

                      payeeType
                      *
                      

String

Mandatory

Merchant's type ex:SMALL, LARGE

                      payeeAddr
                      *
                      

String

Mandatory

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

                      fxList
                      *
                      

String

Mandatory

                      fx
                      *
                      

String

Mandatory

Foreign exchange rate
Values: Decimal String, with 2 decimal places

                      mkup
                      *
                      

String

Mandatory

Markup rate

                      baseAmount
                      
                      

String

optional

Amount in base currency
Values: Decimal String, with 2 decimal places. Only populated in case of dynamic QR

                      baseCurr
                      *
                      

String

Mandatory

Base currency

                      convertedAmount
                      
                      

String

optional

converted amount based on the country
Values: Decimal String, with 2 decimal places. Only populated in case of dynamic QR

                      lastModifiedTs
                      
                      

String

optional

Last modified time of the QR as received from NPCI

                      active
                      
                      

String

optional

Active status for forex as received from NPCI