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\{
2  "funding": {
3  "deposit_type": "DIRECT_DEBIT",
4    "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282",
5    "status": "SCHEDULED"
6  \},
7  "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede",
8  "metadata": \{
9    "order_id": "0123456789"
10  \},
11  "name": "batch-name",
12 "quote_summary": \{
13  "expires_at": "2024-01-24T18:00:02+0000",
14  "last_quoted_at": "2024-01-24T18:03:02+0000",
15  "quotes": [
16    {
17      "amount_beneficiary_receives": 100.0,
18      "amount_payer_pays": 100.0,
19      "fee_amount": 0,
20      "fee_currency": "AUD",
21      "transfer_currency": "AUD",
22      "source_currency": "AUD"
23    \},
24    \{
25      "amount_beneficiary_receives": 200.0,
26      "amount_payer_pays": 308.44,
27      "client_rate": 0.648414,
28      "currency_pair": "AUDUSD",
29      "fee_amount": 0,
30      "fee_currency": "AUD",
31      "transfer_currency": "USD",
32      "source_currency": "AUD"
33     \}
34  ]
35 },
36  "remarks": "Any information",
37  "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911",
38  "short_reference_id": "B231018-TMA1RTC",
39  "status": "DRAFTING",
40  "total_item_count": 4,
41  "transfer_date": "2024-01-24",
42  "updated_at": "2024-01-24T18:00:02+1100",
43  "valid_item_count": 3
44}
45```
46
47## List all batch transfers
48
49Call [List all batch transfers](/api#/Payouts/Batch_Transfers/_api_v1_batch_transfers/get) to retrieve batch transfers based on specific conditions.
50
51You 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).
52
53### Example request
54
55```curl
56curl --request GET \
57--url 'https://api-demo.airwallex.com/api/v1/batch_transfers?page_size=2&status=BOOKED&page=YWZ0ZXI9YzA0NTRjYWUtYmYxZS00MDVmLTlkZGUtMmVmYmRkZWNlOGZl' \
58--header 'Content-Type: application/json' \
59--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q'
60```
61If 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.
62
63### Example response
64
65```json
66{
67    "items": [
68        {
69            "funding": {
70                "deposit_type": "DIRECT_DEBIT",
71                "funding_source_id": "ff621b96-9ee9-4429-9dd7-9defef411d11",
72                "status": "FUNDED"
73            },
74            "id": "77ed20ee-9996-4051-a704-1e6ef0589120",
75            "metadata": {
76                "key1": "value",
77                "key2": "value"
78            },
79            "name": "batch-name1",
80            "quote_summary": {
81                "expires_at": "2023-08-09T11:27:48+0000",
82                "last_quoted_at": "2023-08-09T11:27:48+0000",
83                "quotes": [
84                    {
85                        "amount_beneficiary_receives": 200.0,
86                        "amount_payer_pays": 220.0,
87                        "fee_amount": 20.0,
88                        "fee_currency": "AUD",
89                        "transfer_currency": "AUD",
90                        "source_currency": "AUD"
91                    },
92                    {
93                        "amount_beneficiary_receives": 193.49,
94                        "amount_payer_pays": 317.44,
95                        "client_rate": 0.650523,
96                        "fee_amount": 20.0,
97                        "fee_currency": "AUD",
98                        "transfer_currency": "USD",
99                        "source_currency": "AUD"
100                    }
101                ]
102            },
103            "remarks": "information",
104            "request_id": "202307271111111121",
105            "short_reference_id": "B230809-WG9OZZJ",
106            "status": "BOOKED",
107            "total_item_count": 4,
108            "updated_at": "2023-08-09T11:35:51+0000",
109            "valid_item_count": 4
110        },
111        {
112            "funding": {
113                "deposit_type": "DIRECT_DEBIT",
114                "funding_source_id": "ff621b96-9ee9-4429-9dd7-9defef411d11",
115                "status": "FUNDED"
116            },
117            "id": "c109b7fe-a625-405c-90a2-d6f5a7251b6b",
118            "metadata": {
119                "key1": "value",
120                "key2": "value"
121            },
122            "name": "batch-name2",
123            "quote_summary": {
124                "expires_at": "2023-08-08T07:48:23+0000",
125                "last_quoted_at": "2023-08-08T07:48:23+0000",
126                "quotes": [
127                    {
128                        "amount_beneficiary_receives": 200.0,
129                        "amount_payer_pays": 220.0,
130                        "fee_amount": 20.0,
131                        "fee_currency": "AUD",
132                        "payment_currency": "AUD",
133                        "source_currency": "AUD"
134                    },
135                    {
136                        "amount_beneficiary_receives": 193.51,
137                        "amount_payer_pays": 318,
138                        "client_rate": 0.649352,
139                        "fee_amount": 20.0,
140                        "fee_currency": "AUD",
141                        "payment_currency": "USD",
142                        "source_currency": "AUD"
143                    }
144                ]
145            },
146            "remarks": "information",
147            "request_id": "20230727112115",
148            "short_reference_id": "B230808-CMSIC8L",
149            "status": "BOOKED",
150            "total_item_count": 4,
151            "updated_at": "2023-08-08T07:48:39+0000",
152            "valid_item_count": 4
153        }
154    ],
155    "page_after": "YWZ0ZXI9YzEwOWI3ZmUtYTYyNS00MDVjLTkwYTItZDZmNWE3MjUxYjZi",
156    "page_before": "YmVmb3JlPTc3ZWQyMGVlLTk5OTYtNDA1MS1hNzA0LTFlNmVmMDU4OTEyMA=="
157}
158```
159
160## List all items within a batch
161
162Call [List all items within a batch](/api#/Payouts/Batch_Transfers/_api_v1_batch_transfers__id__items/get) to retrieve all items in a batch transfer by specifying the batch transfer id. See more details in __Step 5__ in [Create a batch transfer](/payouts/batch-transfers/create-a-batch-transfer#step-5:-list-all-items-within-a-batch-(optional)).
163
164If 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.

Was this page helpful?