Batch transfer error codes
Batch transfer errors
All possible batch-level errors while creating/managing batch transfers via Batch Transfer API endpoints API are listed in this section. Like the example below, an error response could contain a params object with additional parsable information.
Create a batch transfer
Error codes, detailed descriptions, and parameters for Create a batch transfer API.
| Code | Description | Parameters |
|---|---|---|
batch_request_id_duplicate | The request ID has been used to a batch before which was created successfully. Please use a different request ID if you wish to create a separate batch transfer. | - |
transfer_date_invalid | The transfer date specified is not valid. You can only specify a transfer date when using Wallet as the funding source. | - |
metadata_above_size_limit | The number of metadata keys should be smaller than 15, and the total number of metadata characters should be smaller than 4500. | - |
invalid_deposit_type | The deposit type specified is not valid. Please specify either DIRECT_DEBIT or FASTER_DIRECT_DEBIT. | - |
invalid_funding_source | The funding source you provided is not valid. Please check your funding source status by Retrieving details of your Linked Account. | - |
service_unavailable | Service is unavailable at this moment. Please try again later. | - |
invalid_argument | The argument you provided is not valid. Please update and try again. | - |
Add items to a batch
Error codes, detailed descriptions, and parameters for Add items to a batch API.
| Code | Description | Parameters |
|---|---|---|
transfer_amount_currency_unsupported | You can either specify the source amount or the payment amount for all items in the batch. | - |
request_id_in_batch_duplicate | The request ID has been used for another item in the batch. Please use a unique request ID for each batch item. | - |
add_batch_items_unsupported | Items cannot be added to the batch transfer in its current status. You can only add items to batch transfer in DRAFTING status. See Batch transfer statuses to learn more. | - |
too_many_items_per_request | The item count exceeds the maximum limit per request. You should add up to 100 batch items at a time. | - |
payout_size_too_large | TThe total item count exceeds the maximum limit for a batch. You can only add up to 1,000 items for a batch transfer. | - |
multiple_source_currencies_unsupported | When Linked Account is used as the funding source, the batch transfer only supports one source currency for all items in the batch. | - |
service_unavailable | Service is unavailable at this moment. Please try again later. | - |
invalid_argument | The argument you provided is not valid. Please update and try again. | - |
Quote a batch transfer
Error codes, detailed descriptions, and parameters for Quote a batch transfer API.
| Code | Description | Parameters |
|---|---|---|
quote_unsupported | The batch transfer in its current status cannot be quoted. You can only quote a batch in DRAFTING status. See Batch transfer statuses to learn more. | - |
service_unavailable | Service is unavailable at this moment. Please try again later. | - |
invalid_argument | The argument you provided is not valid. Please update and try again. | - |
Submit a batch transfer
Error codes, detailed descriptions, and parameters for Submit a batch transfer API.
| Code | Description | Parameters |
|---|---|---|
submit_unsupported | The batch transfer in its current status cannot be submitted. You can only submit a batch in the DRAFTING status. See Batch transfer statuses to learn more. | - |
quote_expired | The quote for this batch transfer has expired. Please call Quote a batch transfer API and submit again. | - |
balance_insufficient | There is insufficient Wallet balance to fund this batch transfer. Top up your Wallet balance or provide a lower amount. | - |
order_amount_insufficient | Orders for your China local payout is insufficient. Valid orders equivalent to the payout amount is required per local regulations. Learn more about uploading orders by connecting to marketplaces via token authorization here or calling Upload order items API. | - |
open_position_limit_exceeded | The batch payment amount exceeds the remaining open position limit under the post fund model. Provide a lower amount or top up your Wallet balance. See here to learn more about funding models. | - |
amount_beneficiary_receives_above_cumulative_limit | The amount beneficiary receives (payment amount less fees paid by beneficiary) is above the maximum cumulative limit as defined in the params object. Provide a lower amount (for Malaysian customers only). | amount_bene_receives: payment amount less fees paid by beneficiary (if applicable); daily_amount_max: the maximum daily cumulative limit for the amount beneficiary receives; daily_amount_max_currency: currency of the maximum daily cumulative amount limit |
service_unavailable | Service is unavailable at this moment. Please try again later. | - |
invalid_argument | The argument you provided is not valid. Please update and try again. | - |
Delete a batch transfer
Error codes, detailed descriptions, and parameters for Delete a batch transfer API.
| Code | Description | Parameters |
|---|---|---|
delete_unsupported | The batch transfer in its current status cannot be deleted. You can only delete a batch in the DRAFTING status. See Batch transfer statuses to learn more. | - |
service_unavailable | Service is unavailable at this moment. Please try again later. | - |
invalid_argument | The argument you provided is not valid. Please update and try again. | - |
Batch transfer item errors
All possible batch item-level errors while adding items or booking a batch are listed below.
Validation errors for a batch item
If a batch item fails the schema validation, the batch item status will transition to VALIDATION_FAILED. Like the example below, the response contains an errors object with:
source: The specific field within the request that has failed schema validation.code: Unique numeric identifier of the specific validation error encountered.params: Additional parsable information relating to the specific validation error where applicable, e.g. minimum and maximum character length.
You may find all item validation errors in Field validation errors for payouts.
Booking errors for a batch item
If a batch item fails to be booked, the batch item status will transition to BOOKING_FAILED. An error response example is shown below.
All possible item-level booking error codes are listed below.
| Code | Description | Parameters |
|---|---|---|
order_amount_insufficient | Orders for your China local payout is insufficient. Valid orders equivalent to the payout amount is required per local regulations. Learn more about uploading orders by connecting to marketplaces via token authorization here or calling Upload order items API. | - |
balance_insufficient | There is insufficient Wallet balance to fund this batch transfer. Top up your Wallet balance or provide a lower amount. | - |
request_id_already_used | The request ID has been used. Please use a unique request ID for each batch item. | - |
open_position_limit_exceeded | The batch payment amount exceeds the remaining open position limit under the post fund model. Provide a lower amount or top up your Wallet balance. See here to learn more about funding models. | - |
amount_beneficiary_receives_above_cumulative_limit | The amount beneficiary receives (payment amount less fees paid by beneficiary) is above the maximum cumulative limit as defined in the params object. Provide a lower amount (for Malaysian customers only). | - |
order_reconciliation_failed | Orders for your China local payout have not settled. Valid orders equivalent to the payout amount is required per local regulations. Please try again later. | - |
service_unavailable | Service is unavailable at this moment. Please try again later. | - |
Direct debit deposit errors (async)
If the batch transfer is funded via direct debit from Linked Account, the funds will generally take 2-11 business days to settle (Learn more about direct debit flight time here). If the deposit is rejected as it failed validation by either Airwallex or the banking scheme, the funding status will transition to FAILED and the funds will be returned to your external bank account. Please note that this type of error is asynchronous.
Like the example below, the funding object could contain a failure_reason for direct debit deposit errors.