Retrieve beneficiaries

Retrieve a list of beneficiaries

Call Get list of beneficiaries API to retrieve saved beneficiary information. You can specify the time period when the beneficiary was created (from_date, to_date) and the pagination parameters (page_num, page_size) to refine the results. You can also use other filters such as bank_account_number, company_name, entity_type, and nick_name. The response will return a list of beneficiaries, each in the same manner as in the response body of Create a beneficiary API.

Example request

Shell
1curl --request GET \
2--url 'https://api-demo.airwallex.com/api/v1/beneficiaries?bank_account_number=string&entity_type=COMPANY&from_date=2017-04-01&name=Adam&nick_name=string&page_num=0&page_size=100&to_date=2030-01-01T00%3A00%3A00%2B0000' \
3--header 'Authorization: Bearer <your_bearer_token>'

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  "has_more": false,
3  "items": [
4    {
5      "beneficiary": {
6        "address": {
7          "city": "Melbourne",
8          "country_code": "AU",
9          "postcode": "3000",
10          "state": "VIC",
11          "street_address": "15 William Street"
12        },
13        "bank_details": {
14          "account_currency": "AUD",
15          "account_name": "Lee Da Ming",
16          "account_number": "12750852",
17          "account_routing_type1": "bsb",
18          "account_routing_value1": "083064",
19          "bank_account_category": "Checking",
20          "bank_branch": "Melbourne",
21          "bank_country_code": "AU",
22          "bank_name": "National Australia Bank",
23          "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",
24          "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",
25          "local_clearing_system": "BANK_TRANSFER",
26          "transaction_reference": "4140110135"
27        },
28        "entity_type": "COMPANY",
29        "type": "BANK_ACCOUNT"
30      },
31      "id": "8365ea88-2946-4877-abe1-e02a1015288d",
32      "nickname": "Complete Concrete Pty Ltd",
33      "payer_entity_type": "COMPANY",
34      "transfer_methods": [
35        "LOCAL"
36      ]
37    }
38  ]
39}

Retrieve details of a beneficiary

Call Get a beneficiary by ID API to retrieve details of a specific saved beneficiary, by specifying the beneficiary_id in the endpoint URL. A successful request will return the beneficiary details in the same manner as in the response body of Create a new beneficiary API.

Example request

Shell
1curl --request GET \
2--url 'https://api-demo.airwallex.com/api/v1/beneficiaries/<beneficiary_id>' \
3--header 'Authorization: Bearer <your_bearer_token>'

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.