Log inGet started
Airwallex logo
Home
Online Payments
Treasury
Transactional FX
Payouts
Issuing
Scale
Open Banking
Developer Tools
API Reference
Home
Scale
Overview
Why use Scale?Case study - Marketplace platformCase study - Invoicing / supply chain financing platform
Transacting
Receiving fundsChargesWallet transfersCurrency conversionPayout to bank account
Supported payment currenciesFormatting payment instructionsManaging contacts
Wallet balancesFee

Managing contacts

Create a new beneficiary

Save payer and beneficiary details for future use via the Contact API. Specify the bank account details of an intended recipient using the Create a new beneficiary API.

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/beneficiaries/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
--data '{ \
"beneficiary": { \
"additional_info": { \
  "personal_email": "[email protected]" \
}, \
"address": { \
  "city": "Seattle", \
  "country_code": "US", \
  "postcode": "98104", \
  "state": "Washington", \
  "street_address": "412 5th Avenue" \
}, \
"bank_details": { \
  "account_currency": "USD", \
  "account_name": "John Walker", \
  "account_number": "50001121", \
  "account_routing_type1": "aba", \
  "account_routing_value1": "021000021", \
  "bank_country_code": "US", \
  "bank_name": "JP Morgan Chase Bank" \
}, \
"company_name": "ABC University", \
"date_of_birth": "1976-08-26", \
"entity_type": "COMPANY" \
}, \
"nickname": "ABC University", \
"payment_methods": [ \
"LOCAL" \
] \
}'

Create a new payer

If your account is configured to allow payments from your wallet on behalf of an entity other than yourself, you can also specify details of the payer using the Create a new payer API.

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/payers/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
--data '{ \
"nickname": "Complete Concrete Pty Ltd", \
"payer": { \
"additional_info": { \
  "business_registration_number": "EU300503", \
  "personal_email": "[email protected]" \
}, \
"address": { \
  "city": "Melbourne", \
  "country_code": "CN", \
  "postcode": "3000", \
  "state": "VIC", \
  "street_address": "15 William Street" \
}, \
"company_name": "Complete Concrete Pty Ltd", \
"entity_type": "COMPANY" \
} \
}'