Validate a beneficiary

Call Validate a beneficiary API to check for errors before creating a beneficiary:

If validation errors are found, a list of all errors will be returned as a 400 response.
If all parameters provided for the payout are valid, the endpoint will return a 200 (OK) response.

To learn more about error response structures and detailed descriptions of error codes, please see Error codes.

Example request

Shell

1curl -X POST https://api-demo.airwallex.com/api/v1/beneficiaries/validate \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "beneficiary": {
6      "additional_info": {
7        "personal_email": "[email protected]"
8      },
9      "address": {
10        "city": "Seattle",
11        "country_code": "US",
12        "postcode": "98104",
13        "state": "Washington",
14        "street_address": "412 5th Avenue"
15      },
16      "bank_details": {
17        "account_currency": "USD",
18        "account_name": "John Walker",
19        "account_number": "50001121",
20        "account_routing_type1": "aba",
21        "account_routing_value1": "021000021",
22        "bank_country_code": "US",
23        "local_clearing_system": "ACH"
24      },
25      "entity_type": "COMPANY"
26    },
27    "nickname": "Complete Concrete Pty Ltd",
28    "transfer_methods": [
29      "LOCAL"
30    ]
31  }'

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 error response

JSON

1{
2    "code": "validation_failed",
3    "message": "This is not valid.",
4    "details": {
5      "errors": [
6          {
7              "source": "beneficiary.address.postcode",
8              "code": "030"
9          },
10          {
11               "source": "beneficiary.address.street_address",
12               "code": "018",
13               "params": { 
14                  "length_min": 5,
15                  "length_max": 200
16              }
17         }
18     ]
19  }
20}

Was this page helpful?