Retrieve Customer Record API

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

ParameterDescriptionExample
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 Prepaid2000
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., 100100
secureCode
mandatory
String Uniquely identifies the client on payload level for performing operations.AfYtlO5kqdySIjXyNmGg3F

Body

ParameterDescriptionExample

Encrypted

token
mandatory
String Token is the Encrypted body of the below request AES-192-CBC bits Encryption 

Decrypted

messageCode
mandatory
Numeric Code to Identify load card request type. Character Limit - 41080
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 - 13919888888888
customerId conditionalString 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 - 1170000000008
cardNo conditionalString Encrypted card Number of the card holder. Character Limit - 10UZUTS8wt00q2IZ
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

ParameterDescriptionExample

Encrypted

tokenToken is the Encrypted body of the below request AES-192-CBC bits Encryption Pl8F5kDZcvADIiursiAvv
bHNuL9Wv5eaFdorGVFU6F
KfIEnV/YskkzJlAov2ZHJ
WnqGNLOXfBq4SQqw8Ep4
sK0gCAAkRXATCb1nSY6s=

Decrypted

UrnA unique reference number for the generated wallet.70000000008
customerIdCustomer Id(entity CIF), which uniquely identifies the cardholder in the client systemAMLCustomer82
statusDescriptionField to send information about the card statusActive
responseCodeContains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes0
messageCodeCode to Identify retrieve customer record api response type3423
clientTxnIdValue copied from the request923eh42r3jbd4335r3et53
responseDateTimeResponse date time in the format YYYYMMDDHHMMSS with time in 24 hr format20220620195326
accosaTransactionIDUnique id for a particular transaction generated in Prepaid3541
responseMessageResponse message based on response code will be sentSUCCESS
bankIdBank Id is provided by Prepaid Aero during program enrolment to uniquely identify the card issuer7000
availableBalanceCard available balance (implied decimals)100000
cardStatusStatus of the card.
0 – Active
1 – Icc Authorized
9 – Pre active
21 – Disabled
12 – Temporary Block
13 – Permanent Block
14 – Icc Expired
0
profileIdExample : 150 – Full CDD 30 – Simple CDD30
MobileMobile number with country code of the cardholder.919888888888
firstNameFirst Name of the cardholderRanjan
lastNameFirst Name of the cardholderS
DobDate of Birth of the Customer in DD-MMM-YYYY format.1993-04-14 00:00:00
updatedOnLocal Date and time stamp of when the card/wallet profile got updated most recently. in DD-MMM-YYYY format2023-05-11 00:00:00
kycNameThis field will contain card Profile name (SIMPLE_CDD, FULL_CDD, NO_CDD etc.)SIMPLE_CDD
reKycReKyc status of the user:
- True- Eligible for reKyc
- False- reKyc Not required
True
docTypeDocument Type Of the CardHolder. One Card Holder can have many Documents.Aadhar,Pancard, VoterId, Driverlicense, Passport, jobcard, etc
docNumberOVD No. need to be passed. like adhar Number ,Pan card Number3675 XXXX 6015
createdOnLocal Date when the card/wallet profile got created. in DD-MMM-YYYY format2021-07-25 00:00:00
subwallet_idId of the subwallet“Mob6bbbaa78_1”
default_walletChecks if the subwallet is default one or not1
available_balanceBalance available in the subwallet account. implied decimals applied (2 digit)“1000000”
account_numberAccount number of the subwallet“604010000478”
account_statusAccount status of the subwallet“0”-activate
subwallet_nameName of the subwallet“GPR single wallet”
panValidIs PAN validated or not 
clientIdIt is unique id for each client2000
cardNumberCard Number linked with urn545454 XXXXXX 3329
lastFourDigitIt is last 4 digit of card Number3329
cardTypeName of the program/product typeGPR

API error codes

Error CodeDescription
00SUCCESS
1001CARD_NOT_FOUND
1031INVALID_BANK_ID
1032INVALID CLIENT CHANNEL
1034INVALID_MOBILE_NUMBER
1052SYSTEM_ERROR
1054DUPLICATE_REQUEST
1055MALFORMED_REQUEST
1056INVALID MESSAGE CODE
1088INVALID REQUEST DATE FORMAT
1092INVALID_EMAIL_ADDRESS
1093INVALID_CLIENT_TXN_ID
1237DUPLICATE_MOBILE_NUMBER_WITH_MULTIPLE_ACCOUNT
1248INVALID_JWT_TOKEN
1263CUSTOMER_ID_NOT_PRESENT
1264BANK ID NOT PRESENT IN THE REQUEST
1275INVALID_CUSTOMER_ID
1302INVALID_CUSTOMER
1303CUSTOMER_DETAILS_NOT_PRESENT
1304MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED
1307DUPLICATE_EMAIL_ID_LINKED_WITH_MULTIPLE_ACCOUNTS
1320REQUEST_DATETIME_IS_MANDATORY
1500SYSTEM_ERROR_UNKNOWN
1501SYSTEM_ERROR_DB
1503SYSTEM_ERROR_CACHE
1510SYSTEM_ERROR_DROP_REQ
1511ORIGINAL_REQUEST_MISSING
5000DUPLICATE REQUEST

HTTP status code

HTTP Status CodeHTTP Status Description
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
500Internal Server Error
503Service 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
      }
   ]
}