Retrieve batch transfers

Copy for LLMView as Markdown

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    "validity": "MIN_15"
36 },
37  "remarks": "Any information",
38  "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911",
39  "short_reference_id": "B231018-TMA1RTC",
40  "status": "DRAFTING",
41  "total_item_count": 4,
42  "transfer_date": "2024-01-24",
43  "updated_at": "2024-01-24T18:00:02+1100",
44  "valid_item_count": 3
45}

List all batch transfers

Call List all batch transfers API to retrieve batch transfers based on specific conditions.

You 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.

Example request

Shell

1curl --request GET \
2--url 'https://api-demo.airwallex.com/api/v1/batch_transfers?page_size=2&status=BOOKED&page=YWZ0ZXI9YzA0NTRjYWUtYmYxZS00MDVmLTlkZGUtMmVmYmRkZWNlOGZl' \
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    "items": [
3        {
4            "funding": {
5                "deposit_type": "DIRECT_DEBIT",
6                "funding_source_id": "ff621b96-9ee9-4429-9dd7-9defef411d11",
7                "status": "FUNDED"
8            },
9            "id": "77ed20ee-9996-4051-a704-1e6ef0589120",
10            "metadata": {
11                "key1": "value",
12                "key2": "value"
13            },
14            "name": "batch-name1",
15            "quote_summary": {
16                "expires_at": "2023-08-09T11:27:48+0000",
17                "last_quoted_at": "2023-08-09T11:27:48+0000",
18                "quotes": [
19                    {
20                        "amount_beneficiary_receives": 200.0,
21                        "amount_payer_pays": 220.0,
22                        "fee_amount": 20.0,
23                        "fee_currency": "AUD",
24                        "transfer_currency": "AUD",
25                        "source_currency": "AUD"
26                    },
27                    {
28                        "amount_beneficiary_receives": 193.49,
29                        "amount_payer_pays": 317.44,
30                        "client_rate": 0.650523,
31                        "fee_amount": 20.0,
32                        "fee_currency": "AUD",
33                        "transfer_currency": "USD",
34                        "source_currency": "AUD"
35                    }
36                ],
37                "validity": "MIN_15"
38            },
39            "remarks": "information",
40            "request_id": "202307271111111121",
41            "short_reference_id": "B230809-WG9OZZJ",
42            "status": "BOOKED",
43            "total_item_count": 4,
44            "updated_at": "2023-08-09T11:35:51+0000",
45            "valid_item_count": 4
46        },
47        {
48            "funding": {
49                "deposit_type": "DIRECT_DEBIT",
50                "funding_source_id": "ff621b96-9ee9-4429-9dd7-9defef411d11",
51                "status": "FUNDED"
52            },
53            "id": "c109b7fe-a625-405c-90a2-d6f5a7251b6b",
54            "metadata": {
55                "key1": "value",
56                "key2": "value"
57            },
58            "name": "batch-name2",
59            "quote_summary": {
60                "expires_at": "2023-08-08T07:48:23+0000",
61                "last_quoted_at": "2023-08-08T07:48:23+0000",
62                "quotes": [
63                    {
64                        "amount_beneficiary_receives": 200.0,
65                        "amount_payer_pays": 220.0,
66                        "fee_amount": 20.0,
67                        "fee_currency": "AUD",
68                        "payment_currency": "AUD",
69                        "source_currency": "AUD"
70                    },
71                    {
72                        "amount_beneficiary_receives": 193.51,
73                        "amount_payer_pays": 318,
74                        "client_rate": 0.649352,
75                        "fee_amount": 20.0,
76                        "fee_currency": "AUD",
77                        "payment_currency": "USD",
78                        "source_currency": "AUD"
79                    }
80                ],
81                "validity": "MIN_15"
82            },
83            "remarks": "information",
84            "request_id": "20230727112115",
85            "short_reference_id": "B230808-CMSIC8L",
86            "status": "BOOKED",
87            "total_item_count": 4,
88            "updated_at": "2023-08-08T07:48:39+0000",
89            "valid_item_count": 4
90        }
91    ],
92    "page_after": "YWZ0ZXI9YzEwOWI3ZmUtYTYyNS00MDVjLTkwYTItZDZmNWE3MjUxYjZi",
93    "page_before": "YmVmb3JlPTc3ZWQyMGVlLTk5OTYtNDA1MS1hNzA0LTFlNmVmMDU4OTEyMA=="
94}

List all items within a batch

Call List all items within a batch API 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.

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.

Was this page helpful?