patch https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/debitAccount
The Unload API is used to debit/unload from the wallet. This API can be called during multiple use cases. For example, when the customer makes a payment to a merchant using the available wallet balance.
Sandbox | payusandbox-kong.pc.enstage-sas.com/api/v2/encrypt |
Production | Contact your WIBMO KAM or support. |
Sample request
curl --request PATCH \
--url https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/debitAccount \
--header 'X-Consumer-Custom-ID: F42BC4E7B801C834B630DE498473533F' \
--header 'bankId: 6060' \
--header 'clientId: 1020' \
--header 'content-type: application/json' \
--header 'entityId: 100' \
--header 'secureCode: pu8gSMLNE7pNv36IlUmstU' \
--header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725' \
--data '
{
"token": "TCFSqoj+1LGWCtQVuBB8MaIfQv+7N6Em4j0d6qyuuA58X580vP9ocyh6ROXuQ7ZzcCL6zpTedawIMU8zqLngXQ/4mRztEnmuLZe+sugbmCauKPFY/tdxv4eT41BDwfOXNA5drP0YRciBNfE526SooSPZ8EMYlEfLP3cUWY4WAZc7MWrbNJZ1NSYuLFYH671FoWtzsrS/amwKCHyRsHe6kNYeRhhMHiuHOFDkEeLL37jifYohsOhJWgyCw1jCDlJ5U8CSmwJ5e+m59+u1EdMxTgJnf2gg5kTKPTOmVWON40kZDdZwyq1R16BP5emZowsbIHkATsjsTYI661419EXRK7SVr5Q41/83983gp51PkApU0YboRb/v0OyXfBdWZrfdvMoUzczW0MQJmkEaF13QY/O1wA97F/k6TODPEFwpU1af2kSqFWVXpbImM7wXZVx8kKKWmO+UBTIoYCdGx7i0EIUykynXWVkvQXPZdxvtzSs="
}
'
Response parameters (Decrypted)
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 | Code to identify unload response type |
clientTxnId | String(100) | Mandatory | Value echoed from the request. |
customerId | String(20) | Mandatory | Unique identifier for the customer. |
accosaTransactionId | Numeric(10) | Mandatory | Unique ID for a particular transaction generated in Prepaid. |
urn | Numeric(11) | Mandatory | Unique reference number for the customer. |
transactionAmount | Numeric(12) | Mandatory | Unload Amount passed with implied decimals. |
availableBalance | Numeric(12) | Mandatory | Available Balance in the wallet after successful unload with implied decimals. |
accosaRefNo | Numeric(20) | Mandatory | Auto generated sequence number. |
availableCashLimit | Numeric | Mandatory | Available Cash limit. It will be 0 by default. |
accountToken | String(15) | Mandatory | Specific account token Id to load the money to the account or wallet . |
Sample response (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
}
Error codes
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 |
1054 | DUPLICATE REQUEST |
1056 | INVALID MESSAGE CODE |
1058 | INVALID_WALLETS |
1088 | INVALID REQUEST DATE format |
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 |
1323 | TRANSACTION AMOUNT CANNOT BE ZERO |
1325 | FUND FLOW TYPE MISMATCH |
1326 | IMPL ID MISMATCH |
1354 | CORPORATE_LEVEL_LIMIT_EXCEEDED |
1357 | WALLET DETAILS NOT FOUND |
1363 | INVALID ACTIVITY STATUS |
1366 | PROGRAM IS INACTIVE |
1367 | PROGRAM NOT FOUND |
1368 | WALLET OR ACCOUNTNO SHOULD BE PRESENT |
1376 | INVALID UNLOAD AMOUNT |
1392 | FUND FLOW TYPE NOT PRESENT IN THE REQUEST |
1398 | ACCOUNTNO SHOULD BE PRESENT |
1501 | SYSTEM_ERROR_DB |
1504 | SYSTEM_CACHE_FAILURE |
3007 | UNLOAD AMOUNT SHOULD BE LESS THAN AVAILABLE BALANCE |
6000 | ACCOUNT DORMANT |
6002 | ACCOUNT PERMANENTLY BLOCKED OR CLOSED |
6014 | ACCOUNT IN TEMPORARILY BLOCKED STATE |
6017 | ACCOUNT ALREADY IN CREDIT_DEBIT BLOCKED STATE |
6018 | ACCOUNT ALREADY IN DEBIT BLOCKED STATE |
10066 | RECEIVER NOT PRESENT IN THE REQUEST |
10153 | AMOUNT IS NOT WITHIN MIN-MAX RANGE |
10163 | PROGRAM DAILY LIMIT EXCEEDED |
6935 | SOURCE TYPE SHOULD BE 0 OR 1 |