Withdrawl from budget accountSignature required
Call this API to withdraw money from the budget account.
Structure
A message consists of a header and body. For details, see the following sections.
Request header
Request parameters
requestId String REQUIRED
The unique ID that the Partner assigned to identify this balance withdrawal request.
More information:
- Maximum length: 32 characters
toCurrency String REQUIRED
3-character ISO 4217 currency code that represents the currency used.
Valid values: AUD, CAD, CHF, CNY, CZK, EUR, GBP, HKD, JPY, MXN, NZD, PLN, SEK, SGD, USD
toCurrency must be the same as fromCurrency.
toValue Long REQUIRED
An integer. The value is in the smallest currency unit. For example, if the value is 100, the amount is $1.00 when the currency is USD, or ￥100 when the currency is JPY.
toValue must be equal to fromValue.
fromCurrency String REQUIRED
3-character ISO 4217 currency code that represents the currency used.
Valid values: AUD, CAD, CHF, CNY, CZK, EUR, GBP, HKD, JPY, MXN, NZD, PLN, SEK, SGD, USD
toCurrency must be the same as fromCurrency.
fromValue Long REQUIRED
An integer. The value is in the smallest currency unit. For example, if the value is 100, the amount is $1.00 when the currency is USD, or ￥100 when the currency is JPY.
toValue must be equal to fromValue.
payerBudgetAccountId String REQUIRED
The payer's budget account ID.
Response parameters
result Result REQUIRED
Indicates the result of the API call.
requestId String REQUIRED
The unique ID that the Partner assigned to identify this balance withdrawal request.
More information:
- Maximum length: 32 characters
transactionStatus String REQUIRED
The status of the balance withdrawal. Valid values:
PROCESSING: Transaction is still being processed.SUCCESS: Transaction is successful.FAIL: Transaction has failed.
payeeBalanceType String REQUIRED
The payee's account type. Valid values:
NORMAL_BALANCE: indicates the account balance (also known as the e-commerce balance).SAME_NAME_TOP_UP_BALANCE: indicates the samename funds.
serviceFee Amount REQUIRED
The service fee.
transactionInfoList Array<TransactionInfo> REQUIRED
The details of the transaction.
Request
Response
Result processing logic
After calling the API, a response is returned. The possible responses for result.resultStatus are:
Result status | Description |
| This indicates the API call succeeded. |
| This indicates the API call failed. For more information on why the call failed, see result.resultCode tables. |
| This indicates the API call result is unknown. The partner can call this API again. |
result.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | The service might be down, retry later. If the issue persists, contact our Technical Support Team. |
| REPEAT_REQUEST | F | Repeated request | Change the requestId and retry. |
| ACCESS_TOKEN_EXPIRED | F | The access token expired. | Refresh token to get a new access token or contact out Technical Support Team to address it. |
| AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status. |
| ACCOUNT_NOT_EXIST | F | The payer balance type does not exist. | Set up the correct balance type for this account or pay with another account. |
| BALANCE_INSUFFICIENT | F | Balance not enough | Recharge the current account or pay with another account that has sufficient balance. |