Retrieve batch transfers

Call Retrieve a batch transfer API or List all batch transfers API to retrieve batch transfer details; and List all items within a batch API to retrieve batch transfer item details. Additionally, you can subscribe to Batch Transfers webhook events to receive any batch transfer status transitions. See Batch transfer statuses for more information.

Retrieve a batch transfer

Call Retrieve a batch transfer API to retrieve details of a batch transfer by specifying the batch transfer id.

A successful request will return a response in the same format as Create a batch transfer API.

Example request

Shell
1curl --request GET \
2--url 'https://api-demo.airwallex.com/api/v1/batch_transfers/d9af1614-a6a1-4d45-aae7-6858fc6d9ede' \
3--header 'Content-Type: application/json' \
4--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q'

If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.

Example response

JSON
1## List all batch transfers
2
3Call [List all batch transfers](/api#/Payouts/Batch_Transfers/_api_v1_batch_transfers/get) to retrieve batch transfers based on specific conditions.
4
5You can specify the `status` to filter batch transfers. You can also use the pagination parameters (page, page_size) to refine the results. The response will be in the same format as [Create a batch transfer](/api#/Payouts/Batch_Transfers/_api_v1_batch_transfers_create/post).
6
7### Example request