The primary purpose of the Verify Cardholder API is to validate the cardholder’s details before allowing the cardholder to view or perform any critical/sensitive activities like initiating KYC or setting PIN etc.
Note:
The Verify CardholderAPI will only verify cardholder details and not perform any other activity.
The input parameters mentioned in this API (Example: email, mobile, urn/last4Digit etc.) gets verified against the details maintained for this cardholder in Prepaid system. If verified successfully, the Verify Cardholder API shares useful cardholder information in its response.
Environment: https://domain/mob1/API/onboarding/v1/verifyCardholder
HTTP Method: POST
Request parameters
<WalletHeader />
Body
Note:
Encryption or decryption methodology is AES-192-CBC bits encryption.
Parameter | Description | Example |
|---|---|---|
Encrypted | ||
token |
| Pl8F5kDZcvADIiursiA |
Decrypted | ||
messageCode |
| 1080 |
clientTxnId |
| GOUd789hhhjfscs |
requestDateTime |
| 20161031214559 |
urn |
| 70000000008 |
cardholderMobile |
| 919888888888 |
last4Digits |
| 4664 |
email |
| |
cardExpiry |
| 0X21 |
dob |
| 12-06-2000 |
Sample request
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”Packet sample (Decrypted)
Request With last4Digits, cardExpiry, dob
{
"messageCode": 3020,
"clientTxnId": "verifyCard000012",
"requestDateTime": "20220615123143",
"last4Digits": "1036",
"cardExpiry": "0X20",
"dob": "11-07-1993"
}Request With urn, customerMobile and emailId
{
"messageCode": 3020,
"clientTxnId": "verifyCard0278",
"requestDateTime": "20220615123143",
"urn": "70000000008 ",
"customerMobile": "600140016908",
"emailId": "[email protected]"
}Response parameters
Parameter | Description | Example |
|---|---|---|
Encrypted | ||
token | Token is the Encrypted body of the below request AES-192-CBC bits Encryption | Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb1nSY6s= |
Decrypted | ||
messageCode | Code to Identity create card response type | 1011 |
clientTxnId | Value copied from the request | 20150701235959xhstiesqfds |
responseDateTime | Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format | 20161031214559 |
customerId | Customer ID generated by client stored against customer’s prepaid instrument. | IN2016201611 |
responseCode | Contains the status of the transaction. 201 indicates CREATED. Please refer Appendix for other response codes | 201 |
responseMessage | Response message based on response code will be sent | Card creation successful |
urn | A unique reference number for the generated card/wallet by Prepaid system | 70000000008 |
cardType | Defines the type of card either: Gift,GPR,Travel etc.. | Gift |
isPanValid | Notify whether the pan is validated or not | Y |
bankId | Value copied from request header | 7000 |
last4digits | Last 4 digit of the customer card number | 3781 |
clientId | Unique ID for client | 2000 |
keyStatus | This profile ID indicates the KYC type of the customer Simple CDD (Simple CDD with cashloading facility) Full CDD | FULL_CDD |
API error codes
| Error Code | Description |
|---|---|
| 0 | SUCCESS |
| 1001 | CARD_NOT_FOUND |
| 1030 | INVALID MESSAGE |
| 1031 | INVALID BANK ID |
| 1032 | INVALID_CLIENT_CHANNEL |
| 1049 | INVALID SECURE CODE |
| 1051 | CHECKSUM FAILURE |
| 1052 | SYSTEM_ERROR |
| 1055 | MALFORMED_REQUEST |
| 1058 | INVALID WALLETS |
| 1080 | IP_NOT_ALLOWED |
| 1081 | OPERATION NOT ALLOWED |
| 1084 | CARD_CUSTOMER_ID_MISMATCH |
| 1085 | PRODUCT NOT ALLOWED |
| 1088 | INVALID DATE FORMAT |
| 1093 | INVALID CLIENT TXN ID |
| 1262 | CLIENT ID NOT PRESENT |
| 1264 | BANK ID NOT PRESENT |
| 1302 | INVALID_CUSTOMER |
| 1303 | CUSTOMER DETAILS NOT PRESENT |
| 1304 | MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED |
| 1310 | XCONSUMERKEY NOT PRESENT |
| 1311 | SECURE CODE NOT PRESENT |
| 1320 | REQUEST_DATETIME_IS_MANDATORY |
| 1332 | URN_MOBILE_EMAIL_MISSING |
| 1333 | LAST4DIGIT_EXPIRY_DOB_MISSING |
| 1334 | WRONG_CUSTOMER_IDENTIFIER_NOT_ALLOWED |
| 1335 | INVALID_LAST_4_DIGIT |
| 1336 | CUSTOMER_WITH_MULTIPLE_ACCOUNT |
HTTP status code
| HTTP Status Code | HTTP Status Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Internal Server Error |
| 403 | Forbidden |
| 404 | Not Found |
| 503 | Service Unavailable |
Sample response
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}Packet sample (Decrypted)
Success scenario
{
"urn": 70000000008,
"customerId": "62507sree425",
"responseCode": "00",
"messageCode": 3021,
"clientTxnId": "verifyCard000011",
"clientId": "2000",
"responseDateTime": "20220914144454",
"accosaTransactionId": 487069,
"responseMessage": "SUCCESS",
"bankId": 7000,
"last4Digits": "1036",
"cardType": "TRAVEL CARD",
"isPanValid": "N",
"kycStatus": "NO CDD"
}Failure scenario
{
"urn": 70000000008,
"responseCode": "1332",
"messageCode": 3021,
"clientTxnId": "verifyCard000039",
"clientId": "wibmobank",
"responseDateTime": "20220914200827",
"accosaTransactionId": 487106,
"responseMessage": "URN_MOBILE_EMAIL_MISSING_IN_REQUEST",
"bankId": 7000
}