The Retrieve Customer Record API return the customer profile based on urn or customer ID or customer mobile or customer email Id or encrypted card number if available.
Environment: https://domain/mob1/api/onboarding/v2/retrieveCustRecord
HTTP Method: POST
Note:
The domain will be shared once this move to respective environment.
Request parameters
Header
| Parameter | Description | Example |
|---|---|---|
| x-api-key mandatory | String This is a unique key. | 7fe1c0de |
| clientId mandatory | String Uniquely identifies the client. During program enrolment each client is provided with a unique client id by Prepaid | 2000 |
| bankId mandatory | Numeric Bank Id is provided by Prepaid Aero during program enrolment to uniquely identify the card issuer. | 7000 |
| entityId mandatory | Numeric Defaults to parent branch i.e., 100 | 100 |
| secureCode mandatory | String Uniquely identifies the client on payload level for performing operations. | AfYtlO5kqdySIjXyNmGg3F |
Body
| Parameter | Description | Example |
|---|---|---|
| ||
| token mandatory | String Token is the Encrypted body of the below request AES-192-CBC bits Encryption | |
| ||
| messageCode mandatory | Numeric Code to Identify load card request type. Character Limit - 4 | 1080 |
| clientTxnId mandatory | String Unique ID generated by the client for each transaction.Character Limit - 14 | GOUd789hhhjfscs |
| requestDateTime mandatory | Numeric Local Date and time stamp when the transaction originated from the client in YYYYMMDDHHMMSS with time in 24 hr format.Character Limit - 14 | 20230511100234 |
| customerMobile conditional | Numeric Mobile number of the cardholder. Conditional with customer id and Urn i.e either one of them should be present. Please append 91 at the beginning of this field. Character Limit - 13 | 919888888888 |
| customerId conditional | String Customer Id (entityCIF), which uniquely identifies the cardholder in the client system. Conditional with mobile number and URN i.e either one of them should be present.Character Limit - 20 | 11001188721 |
| emailId conditional | String Email Address of the cardholder | [email protected] |
| urn conditional | String A unique reference number for the generated card. Need to share this in request body of the APIs. Conditional with mobile number and Customer Id i.e either one of them should be present.Character Limit - 11 | 70000000008 |
| cardNo conditional | String Encrypted card Number of the card holder. Character Limit - 10 | UZUTS8wt00q2IZ fgsdfgsfdgdfsgffsg |
Note:
You must post any one of the conditional parameters in request.
Sample request
Request packet (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFb
CKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6Cmq RHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
}
Request Packet (Decrypted)
{
"messageCode": "1010",
"productId": "1",
"clientTxnId": "wibffgjkfdfgffg7f321", "requestDateTime": "2023050914729", "firstName": "SandeepKvP", "lastName": "S",
"mobile": "919888888888", "customerId": "625778hj4fff", "dateOfBirth": "11-07-1993",
"cardProfileId": "30", "sourceAccountType": 11, "docList": [
{
"docType": "Pancard", "docCountry": "India", "docExpiry": "20231201",
"docNumber": "ABCDE1234A" },
{
"docType": "VoterId", "docCountry": "Argentina", "docExpiry": "20231201", "docNumber": "YCV0189823"
},
{
"docType": "Aadhar",
"docCountry": "India,U.S,Argentina", "docExpiry": "20231201", "docNumber": "3849 9070 1992", "cKycDocNo": "123456", "docConsent": "true"
}, {
}, {
"docType": "Passport", "docCountry": "India", "docExpiry": "20231201", "docNumber": "A1234567"
"docType": "Driverlicense", "docCountry": "U.S",
"docExpiry": "20231201", "docNumber": "DL14 20110012345"
} ],
"newCardStatus": "Active",
"loadAmount": "0",
"eventid": 303001
}
Response parameters
API error codes
| Error Code | Description |
|---|---|
| 00 | SUCCESS |
| 1001 | CARD_NOT_FOUND |
| 1031 | INVALID_BANK_ID |
| 1032 | INVALID CLIENT CHANNEL |
| 1034 | INVALID_MOBILE_NUMBER |
| 1052 | SYSTEM_ERROR |
| 1054 | DUPLICATE_REQUEST |
| 1055 | MALFORMED_REQUEST |
| 1056 | INVALID MESSAGE CODE |
| 1088 | INVALID REQUEST DATE FORMAT |
| 1092 | INVALID_EMAIL_ADDRESS |
| 1093 | INVALID_CLIENT_TXN_ID |
| 1237 | DUPLICATE_MOBILE_NUMBER_WITH_MULTIPLE_ACCOUNT |
| 1248 | INVALID_JWT_TOKEN |
| 1263 | CUSTOMER_ID_NOT_PRESENT |
| 1264 | BANK ID NOT PRESENT IN THE REQUEST |
| 1275 | INVALID_CUSTOMER_ID |
| 1302 | INVALID_CUSTOMER |
| 1303 | CUSTOMER_DETAILS_NOT_PRESENT |
| 1304 | MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED |
| 1307 | DUPLICATE_EMAIL_ID_LINKED_WITH_MULTIPLE_ACCOUNTS |
| 1320 | REQUEST_DATETIME_IS_MANDATORY |
| 1500 | SYSTEM_ERROR_UNKNOWN |
| 1501 | SYSTEM_ERROR_DB |
| 1503 | SYSTEM_ERROR_CACHE |
| 1510 | SYSTEM_ERROR_DROP_REQ |
| 1511 | ORIGINAL_REQUEST_MISSING |
| 5000 | DUPLICATE REQUEST |
HTTP status code
| HTTP Status Code | HTTP Status Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
| 503 | Service Unavailable |
Sample response
Packet sample(Encrypted)
{
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}
Packet sample (Decrypted)
{
"responseCode":"00",
"messageCode":3423,
"clientTxnId":"923eh42r3jbd4335r3et1933",
"clientId":"2000",
"responseDateTime":"20230615234034",
"accosaTransactionId":3541,
"responseMessage":"SUCCESS",
"bankId":7000,
"cardList":[
{
"cardNumber":"817391 XXXXXX 8305",
"lastFourDigit":"8305",
"entityName":"ADMINENTITY",
"cardType":"GPR",
"kycName":"MIN_KYC",
"profileId":30,
"cardStatus":0,
"availableBalance":10000,
"reKyc":false,
"createdOn":"15-Jun-2023",
"updatedOn":"15-Jun-2023",
"ovdName":"",
"firstName":"Sourav",
"lastName":"mishra",
"dob":"11-Jul-1993",
"urn":124,
"customerId":"62508sree0061",
"mobile":"919959788706",
"email":"[email protected]",
"statusDescription":"Active",
"docList":[
],
"transactionProfiles":[
{
"transactionProfileId":1,
"status":false,
"transactionType":"e-Com",
"transactionRegionName":"DOMESTIC"
},
{
}
],
"transactionProfileId":2,
"status":false,
"transactionType":"POS",
"transactionRegionName":"DOMESTIC""subwalletListDetails":[
{
"subwallet_id":"MOB34e36f0d_1",
"default_wallet":1,
"available_balance":"0",
"account_number":"601000210",
"account_status":"0",
"subwallet_name":"GPR Wallet"
},
{
"subwallet_id":"MOB34e36f0d_2",
"default_wallet":0,
"available_balance":"0",
"account_number":"601000229",
"account_status":"0",
"subwallet_name":"Meal Wallet "
},
{
"subwallet_id":"MOB34e36f0d_3",
"default_wallet":0,
"available_balance":"10000",
"account_number":"601000238",
"account_status":"0",
"subwallet_name":"Fuel Wallet "
}
],
"panValid":false
}
]
}