Create a payer

When creating a payout, Airwallex identifies the account owner as the payer by default. For platform accounts that are creating a payout on behalf of their connected accounts, the payer will be the registered owner of the connected account whose open ID is specified in the x-on-behalf-of header. There is no need to specify the payer information in either case.

On a case-by-case approval basis, Airwallex supports POBO (Pay On Behalf Of) i.e. the specification of payer information when creating a payout. This payer information instead of the default account information will appear on the beneficiary bank statement where supported.

With POBO enabled, you can specify a payer optionally when creating payouts in two ways:

1. Specify the id of a payer created previously.
2. Provide values for the payer object directly in the request.

To create a payer, call Create a new payer API with the required payer information. Provide the following parameters in your request if the payer is a business:

• payer.entity_type: Set the value to COMPANY to indicate a business entity.
• payer.additional_info.business_registration_number: The payer’s business registration number.
• payer.address: The payer’s address details.
• payer.company_name: The payer’s company name.

Provide the following parameters in your request if the payer is an individual:

• payer.entity_type: Set the value to PERSONAL to indicate an individual payer.
• payer.address: The payer’s address details.
• payer.first_name: The payer’s first name.
• payer.last_name: The payer’s last name.
• payer.date_of_birth: The payer’s date of birth in ISO 8601 date format.

Refer to the dynamic schema API for further information on required fields.

Example request

Shell
1curl --request POST \
2--url 'https://api-demo.airwallex.com/api/v1/payers/create' \
3--header 'Content-Type: application/json' \
4--header 'Authorization: Bearer <your_bearer_token>' 
5--data '{ 
6  "nickname": "James S", 
7  "payer": { 
8    "address": { 
9      "city": "Melbourne", 
10      "country_code": "AU", 
11      "postcode": "3000", 
12      "state": "VIC", 
13      "street_address": "15 William Street" 
14    }, 
15    "date_of_birth": "1976-08-26", 
16    "entity_type": "PERSONAL", 
17    "first_name": "James", 
18    "last_name": "Smith" 
19  } 
20}'

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  "id": "46c22228-5831-4c53-a4fa-a3ab4954877c",
3  "nickname": "James S",
4  "payer": {
5    "address": {
6      "city": "Melbourne",
7      "country_code": "AU",
8      "postcode": "3000",
9      "state": "VIC",
10      "street_address": "15 William Street"
11    },
12    "date_of_birth": "1976-08-26",
13    "entity_type": "PERSONAL",
14    "first_name": "James",
15    "last_name": "Smith"
16  }
17}