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

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}