Standardized format
All error responses follow a standardized format:1. Error Types
2. invalid_request_error
| Error Code | Error Message | How to Fix |
|---|---|---|
| missing_parameter | Mandatory parameter is missing | Check whether all required request parameters are provided. Add any missing fields (e.g., amount, currency). |
| invalid_parameter | parameter is invalid | Verify the format and value range of the corresponding parameter. |
3. idempotence_error
| Error Code | Error Message | How to Fix |
|---|---|---|
| request_being_processed | request is being processed | Ensure requests are not sent too frequently, particularly within a short interval. |
| key_mismatch_account | key does not belong to account | |
| key_mismatch_api | api associated with key is not the original | Request the original endpoint directly. |
| invalid_key_format | invalid idempotency key format | Using uuid v4 |
4. account_error
| Error Code | Error Message | How to Fix |
|---|---|---|
| account_not_found | account not found or deactivated | |
| sub_account_not_found | sub-account associated with the on-behalf-of not found or deactivated | Ensure the ID specified in the x-on-behalf-of header corresponds to a valid sub-account. |
| user_not_found | user associated with account not found or deactivated | |
| product_not_found | product not found or inactive | Contact technical support. |
5. payment_error
6. refund_error
| Error Code | Error Message | How to Fix |
|---|
7. payout_error
| Error Code | Error Message | How to Fix |
|---|---|---|
| payout_disabled | The Payout service has not been enabled | |
| disabled_transfer_type | This type of payout is disabled by the merchant (e.g., auto-withdrawal turned off) | |
| invalid_currency | Invalid currency | Use a valid and supported currency code. |
| invalid_amount | Invalid amount | |
| invalid_parameter | Missing, malformed, or non-compliant request parameters (e.g., currency code not following ISO 4217, negative amount) | Verify all required parameters are provided and formatted correctly. |
| merchant_account_invalid | Merchant Account Invalid | |
| insufficient_balance | Merchant’s available balance is insufficient | |
| payout_create_fail | Payout create fail | |
| payout_not_found | Payout not found | Verify the payout ID is correct and the payout exists. |

