Body
Get NPCI Token
This api generate a new NPCI token. This token is to be used when calling the Common Library APIs.
npciToken will be returned only if gatewayResponseCode = "00".
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/npci/token
Headers
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.
Request
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints: Alphanumeric string with dot(.). Maximum length is 256.
upiRequestId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints: 35 character alphanumeric. Should always start with merchant prefix provided.
deviceFingerPrint
*
String
Mandatory
Device fingerprint of the customer
tokenRequestType
*
String
Mandatory
Type of operation to be performed on the token
Constraints: String - Pass initial (For New Token Creation), rotate (For Expired Token Updation)
tokenChallenge
*
String
Mandatory
Challenge for the NPCI token generation
Constraints: Base 64 encrypted string as returned by Common Library
udfParameters
Json String
Optional
Stringified JSON for udf parameters
packageName
String
Optional
Package name of the UPI application
clVersion
String
Optional
Common Library Version of the UPI application clVersion
Constraints: Common Library Version of the UPI application (Mandatory for BioAuth payments)
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values: SUCCESS | FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
responseMessage
*
String
Mandatory
PSP response message for the API
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
customerMobileNumber
*
String
Mandatory
Customer mobile number as per device binding
Values: 12 digits mobile number string
gatewayTransactionId
*
String
Mandatory
Transaction id returned by gateway for the request
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
npciToken
String
Optional
NPCI token for Common Library
Values: Base 64 encrypted string
udfParameters
JSON String
Optional
Udf parameters as passed in the request