post https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/retrieveCustRecord
The Retrieve Customer Record API returns the customer profile based on URN/customer ID/customer mobile number.
Environment
| Sandbox | payusandbox-kong.pc.enstage-sas.com/api/v2/encrypt |
| Production | Contact your WIBMO KAM or support. |
Sample request
curl --request POST \
--url https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/retrieveCustRecord \
--header 'content-type: application/json' \
--header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725' \
--data '
{
"token": "e3ln1sSCTF9rgy9AjN5QNAkJruloChEdm7C39FVnfczb5gfIGv/Vg6iSM0ZmzgSwF64Z7yRQ8C+jmDZEUC2rmuM9CCqk5qMQD/AUI7IrXMnSZFV1rEhbGRMJVg0MGxbAa+7+N+Ea1HZk72TlSxUbZsSeRHedWZ+3GsiqU42TRYwQNl5crWPKxtpXRpv9LudcLo56rL5xtHGrNyIzown1d2ah3Lvo4LAQg+6gEyopi+qt6Fl11MJINPAA50OZ5bUkKz8IZq4lTVEMiF7t4BaSpXjv0/FLDG2C4vGtzqU10lyWd2KC+/SZjIpVLQuP7iIk",
"clientId": "1060",
"bankId": "6060",
"entityId": "100",
"secureCode": "pu8gSMLNE7pNv36IlUmstU",
"X-Consumer-Custom-ID": "serfewrfesf"
}
'
Response parameters
This API will provide a token in the response that must be decrypted using the Decrypt API. The decrypted response is similar to the following:
| Parameter | Type | Parameter Requirement | Description |
|---|---|---|---|
| messageCode | Numeric (4) | Mandatory | API response type identifier |
| clientTxnId | String (100) | Mandatory | Echoed from the request. |
| accosaTransactionId | Numeric (10) | Mandatory | Unique ID for a particular transaction generated in Prepaid |
| mobile | Numeric(20) | Mandatory | Mobile number with country code of the customer. |
| firstName | String(50) | Mandatory | Customer first Name |
| lastName | String(50) | Mandatory | Customer last name |
| dob | Numeric(8) | Mandatory | Date of Birth of the Customer in DD-MMM-YYYY format. E.g. 14-Apr-1993 |
| createdOn | Numeric(14) | Optional | Local date when the card/wallet profile was created. In DD-MMM-YYYY format. E.g. 14-Apr-1993 |
| updatedOn | Numeric(14) | Optional | Local timestamp of when the card/wallet profile got updated most recently. In DD-MMM-YYYY format. |
| riskCategory | String (20) | Optional | Type of Risk. (Low, Medium, High) |
| riskScore | Numeric(3) | Optional | Risk score in the system. |
| kycName | String(100) | Mandatory | This field will contain the customer’s KYC profile. E.g. MIN_KYC |
| profileId | Numeric(3) | Mandatory | 150 – Full KYC 30 – Min KYC 300 – Shortfall KYC |
| reKyc | Boolean | Optional | true - ReKYC allowed. false - ReKYC not allowed. Applicable only when ReKYC of the customer needs to be done. |
| reKycExpiry | Numeric (8) | Optional | ReKYC expiry MMYY format. |
| form60 | Boolean | Optional | States whether the form60 was submitted by the customer. |
| panValid | Boolean | Mandatory | true/false Is pan validated or not |
| docList.docType | String(20) | Optional | Document type. |
| docList.docNumber | String(20) | Optional | OVD number stored in the system. |
| cardList.urn | Numeric (11) | Conditional | Unique reference number for the customer |
| cardList.availableBalance | Numeric (12) | Conditional | Available balance in implied decimals. |
| cardList.cardNumber | Numeric | Conditional | Masked card number unique to each customer. |
| cardList.cardStatus | String (2) | Conditional | Status of the card: - 0 – Active - 1 – ICC Authorized - 9 – Pre active - 21 – Disabled - 12 – Temporary Block - 13 – Permanent Block - 14 – ICC Expired |
| cardList.statusDescription | String (30) | Conditional | Status of the card based on the cardStatus parameter. |
| cardList.lastFourDigit | String(4) | Conditional | It is last 4 digit of card Number |
| cardList.transactionProfiles.transactionProfileId | Numeric (3) | Mandatory | Transaction profile ID refers to the transaction channel code. |
| cardList.transactionProfiles.status | Boolean | Mandatory | Whether the channel is active or not. |
| cardList.transactionProfiles.transactionType | String (15) | Mandatory | Transaction channel name |
| cardList.transactionProfiles.transactionRegionName | String (15) | Mandatory | Transaction channel region (domestic or international). |
| cardList.subwalletListDetails.accountNumberValidity | Numeric (4) | Mandatory | Expiry of the card in format MMYY |
| cardList.subwalletListDetails.subsubwallet_id | String | Mandatory | Sub-wallet ID |
| cardList.subwalletListDetails.default_wallet | Numeric(1) | Mandatory | Flag to identify whether the wallet is default or not. (0 or 1) |
| cardList.subwalletListDetails.available_balance | String | Mandatory | Balance available in the wallet account. Implied decimals applied. |
| cardList.subwalletListDetails.account_number | String | Mandatory | Wallet unique identifier. |
| cardList.subwalletListDetails.accountStatus | String | Mandatory | Account status of the wallet. |
| cardList.subwalletListDetails.subsubwallet_name | String | Mandatory | Name of the wallet |
Sample response (Decrypted)
{
"responseCode": "00",
"messageCode": 1931,
"clientTxnId": "923eh42r3jbd4335r3et1933",
"clientId": "2000",
"responseDateTime": "20230615234034",
"accosaTransactionId": 3541,
"responseMessage": "SUCCESS",
"bankId": 7000,
"entityName": "ADMINENTITY",
"kycName": "MIN_KYC",
"profileId": 30,
"createdOn": "15-Jun-2023",
"updatedOn": "15-Jun-2023",
"ovdName": "",
"firstName": "Sourav",
"lastName": "ibmo",
"dob": "11-Jul-1993",
"customerId": "62508sree0061",
"mobile": "919959788706",
"reKyc": false,
"riskCategory": "Low",
"riskScore": 12,
"reKycExpiry": "0822",
"form60": true,
"form60Expiry": "032",
"email": "[email protected]",
"docList": [],
"panValid": false,
"migratedUserFlag": true
},
"cardList": [
{
"cardNumber": "817391 XXXXXX 8305",
"lastFourDigit": "8305",
"productProfile": "GPR",
"cardStatus": 0,
"availableBalance": 10000,
"createdOn": "15-Jun-2023",
"updatedOn": "15-Jun-2023",
"urn": 124,
"statusDescription": "Active",
"transactionProfiles": [
{
"transactionProfileId": 1,
"status": false,
"transactionType": "e-Com",
"transactionRegionName": "DOMESTIC"
},
{
"transactionProfileId": 2,
"status": false,
"transactionType": "POS",
"transactionRegionName": "DOMESTIC"
}
],
"subwalletListDetails": [
{
"subwallet_id": "20034e366091",
"default_wallet": 1,
"available_balance": "0",
"account_number": "601000210",
"account_status": "0",
"subwallet_name": "GPR Wallet",
"accountNumberValidity": "0822"
},
{
"subwallet_id": "MOB34e36f0d_2",
"default_wallet": 0,
"available_balance": "0",
"account_number": "601000229",
"account_status": "0",
"subwallet_name": "Meal Wallet",
"accountNumberValidity": "0822"
}
]
}
]
Response parameters
| 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 |