Unload Wallet API

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.

Sandboxpayusandbox-kong.pc.enstage-sas.com/api/v2/encrypt
ProductionContact 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:

ParameterTypeParameter RequirementDescription
messageCodeNumeric(4)MandatoryCode to identify unload response type
clientTxnIdString(100)MandatoryValue echoed from the request.
customerIdString(20)MandatoryUnique identifier for the customer.
accosaTransactionIdNumeric(10)MandatoryUnique ID for a particular transaction generated in Prepaid.
urnNumeric(11)MandatoryUnique reference number for the customer.
transactionAmountNumeric(12)MandatoryUnload Amount passed with implied decimals.
availableBalanceNumeric(12)MandatoryAvailable Balance in the wallet after successful unload with implied decimals.
accosaRefNoNumeric(20)MandatoryAuto generated sequence number.
availableCashLimitNumericMandatoryAvailable Cash limit. It will be 0 by default.
accountTokenString(15)MandatorySpecific 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 CodeDescription
00SUCCESS
1009CARD_CANCELLED_CLOSED_EXPIRED
1010CARD_TEMPORARY_BLOCK
1012CARD_PENDING_CANCELLATION
1013AML MIN LIMIT
1030INVALID_MESSAGE
1045UNABLE_TO_PROCESS_REQUEST
1045UNABLE_TO_PROCESS_REQUEST
1054DUPLICATE REQUEST
1056INVALID MESSAGE CODE
1058INVALID_WALLETS
1088INVALID REQUEST DATE format
1093INVALID CLIENT TXN ID
1101UNKNOWN_SOURCE_ACCOUNT_TYPE
1102UNKNOWN_DESTINATION_ACCOUNT_TYPE
1117CARD_DEBIT_BLOCK
1118CARD_CREDIT_BLOCK
1121CARD_CREDIT_DEBIT_BLOCK
1128INVALID_TRACE_NUMBER
1135REFUND_AMOUNT_GREATER_THAN_ORIGINAL_TXN_AMOUNT
1246ORIGINAL_TXN_NOT_EXIST
1247SOURCE_ACC_TYPE_NOT_MACHED_WITH_IMPL
1303CUSTOMER DETAILS NOT PRESENT
1304MORE THAN ONE CUSTOMER IDENTIFIER NOT ALLOWED
1323TRANSACTION AMOUNT CANNOT BE ZERO
1325FUND FLOW TYPE MISMATCH
1326IMPL ID MISMATCH
1354CORPORATE_LEVEL_LIMIT_EXCEEDED
1357WALLET DETAILS NOT FOUND
1363INVALID ACTIVITY STATUS
1366PROGRAM IS INACTIVE
1367PROGRAM NOT FOUND
1368WALLET OR ACCOUNTNO SHOULD BE PRESENT
1376INVALID UNLOAD AMOUNT
1392FUND FLOW TYPE NOT PRESENT IN THE REQUEST
1398ACCOUNTNO SHOULD BE PRESENT
1501SYSTEM_ERROR_DB
1504SYSTEM_CACHE_FAILURE
3007UNLOAD AMOUNT SHOULD BE LESS THAN AVAILABLE BALANCE
6000ACCOUNT DORMANT
6002ACCOUNT PERMANENTLY BLOCKED OR CLOSED
6014ACCOUNT IN TEMPORARILY BLOCKED STATE
6017ACCOUNT ALREADY IN CREDIT_DEBIT BLOCKED STATE
6018ACCOUNT ALREADY IN DEBIT BLOCKED STATE
10066RECEIVER NOT PRESENT IN THE REQUEST
10153AMOUNT IS NOT WITHIN MIN-MAX RANGE
10163PROGRAM DAILY LIMIT EXCEEDED
6935SOURCE TYPE SHOULD BE 0 OR 1

Request parameters

Language
URL
Click Try It! to start a request and see the response here!