This API is called by the client to create a debit transaction entry into the wallet. This API can be called during multiple user scenarios.
- When the customer makes a payment to Merchant using available wallet balance.
- When the customer transfers fund from wallet to account (Self or peer)
Client can raise this unload request basis Customer’s customer ID or mobile number or URN.
Environment: https://domain/mob1/api/onboarding/v1/debitAccount
HTTP Method: PATCH
Note:
The domain will be shared once this move to respective environment.
Request parameters
Body
Parameter | Description | Example |
---|---|---|
Encrypted | ||
token |
| Pl8F5kDZcvADIiursiA |
Decrypted | ||
messageCode |
| 1080 |
clientTxnId |
| GOUd789hhhjfscs |
requestDateTime |
| 20161031214559 |
customerMobile |
| 919888888888 |
customerId |
| 11001188721 |
urn |
| 70000000008 |
subwalletId |
| MOB5378a27c_1 |
accountNumber |
| 604010000445 |
receiver |
| Bank name(HDFC)Amazon,JustInPay |
receiverAccount |
| XBC12345778 |
transactionAmount mandatory |
| 525 |
unloadCurrency |
| If this field is not provided by the client, then default option is INR only |
fee |
| 100 |
originalClientTxnId |
| 20150701235 |
refundFileId |
| 20160704091 |
fundFlowType |
| O,I,IO,OR,IR,IOR |
implId |
| IR |
implType |
| P2M_W2A_O, P2M_W2A_O_R or P2P_W2A_I, P2P_W2A_I_R |
pgNo |
| Pg-122 |
orderId |
| O12314 |
beneficiaryId |
| |
receiverAccountType |
| Wallet/account |
sourceType |
| Wallet-0account-1 |
Sample request
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
}
Packet sample (Decrypted)
{
"messageCode": "1480",
"clientTxnId": "GOUTddd0001561217",
"requestDateTime": "20220302153028", "urn": 70000000008,
"subWalletId": "MOB5378a27c_1", "transactionAmount": 10,
"receiver": "MOB1", "receiverAccountType": "wallet", "receiverAccount": " HDFC123445", "unloadCurrency": "RM",
"originalClientTxnId": "", "sourceType": 0,
"implId": "O|70000", "implType": "P2M_W2A_O", "fundFlowType": "O", "pgNo": "PgNo-1", "orderId": "Order2", "beneficiaryId": 1102313, "fee": 0
}
Response parameters
Parameter | Description | Example |
---|---|---|
Encypted | ||
token | Token is the Encrypted body of the below request AES-192-CBC bits Encryption | Pl8F5kDZcvADIiursiAvv |
Decypted | ||
messageCode | Code to Identify load response type | 1081 |
clientTxnId | Value copied from the request | GOUd789hhhjfscs |
responseDateTime | Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format | 20161031214559 |
customerId | Customer Id(entityCIF), which uniquely identifies the cardholder in the client system. | |
Conditional with mobile number and Urn. | 11001188721 | |
responseCode | Contains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes | 0 |
responseMessage | Response message based on response code will be sent | Success |
urn | A unique reference number for the generated card by Prepaid system | 70000000008 |
transactionAmount | Reload Amount passed with implied decimals by two digits | 210000 |
availableBalance | Available Balance in the wallet after successful reload with implied decimals with two digits | 210000 |
accosaRefNo | Auto generated sequence number | 123212 |
availableCashLimit | Available Cash limit. It will be 0 by default | 0 |
API error code
Error Code | Description |
---|---|
00 | SUCCESS |
1009 | CARD_CANCELLED_CLOSED_EXPIRED |
1010 | CARD_TEMPORARY_BLOCK |
1012 | CARD_PENDING_CANCELLATION |
1013 | AML_MIN_LIMIT |
1030 | INVALID_MESSAGE |
1045 | UNABLE_TO_PROCESS_REQUEST |
1045 | UNABLE_TO_PROCESS_REQUEST |
1056 | INVALID MESSAGE CODE |
1058 | INVALID_WALLETS |
1093 | INVALID CLIENT TXN ID |
1101 | UNKNOWN_SOURCE_ACCOUNT_TYPE |
1102 | UNKNOWN_DESTINATION_ACCOUNT_TYPE |
1117 | CARD_DEBIT_BLOCK |
1118 | CARD_CREDIT_BLOCK |
1121 | CARD_CREDIT_DEBIT_BLOCK |
1128 | INVALID_TRACE_NUMBER |
1135 | REFUND_AMOUNT_GREATER_THAN_ORIGINAL_TXN_AMOUNT |
1246 | ORIGINAL_TXN_NOT_EXIST |
1247 | SOURCE_ACC_TYPE_NOT_MACHED_WITH_IMPL |
1303 | CUSTOMER DETAILS NOT PRESENT |
1304 | MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED |
1313 | AML MIN LIMIT |
1322 | TRANSACTION AMOUNT CANNOT BE ZERO |
1325 | FUND FLOW TYPE MISMATCH |
1326 | IMPL ID MISMATCH |
1354 | CORPORATE_LEVEL_LIMIT_EXCEEDED |
1363 | INVALID ACTIVITY STATUS |
1366 | PROGRAM IS INACTIVE |
1368 | PROGRAM NOT FOUND |
1376 | INVALID UNLOAD AMOUNT |
1501 | SYSTEM_ERROR_DB |
1504 | SYSTEM_CACHE_FAILURE |
3007 | UNLOAD AMOUNT SHOULD BE LESS THAN AVAILABLE BALANCE |
10153 | AMOUNT IS NOT WITHIN MIN-MAX RANGE |
10163 | PROGRAM DAILY LIMIT EXCEEDED |
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
Response packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
}
Response packet sample (Decrypted)
{
"urn": 70000000008, "customerId": "130172", "responseCode": "00", "messageCode": 1481, "clientTxnId": "Testram22",
"accosaTransactionId": 2881, “responseDateTime”: "20230803120640",
"responseMessage": "SUCCESS", "accosaRefNo": "41349", "availableBalance": 500, "availableCashLimit": 0, "transactionAmount": 500
}