Bill payments

A typical use case involves paying vendor bills on ERPs or accounts payable management software through a connected Airwallex account. Customers will upload bills to your platform, undergo an approval process, and seamlessly execute payouts to vendors through integration with Airwallex. This eliminates the need to manually enter vendor payment details and initiate transfers via the Airwallex web app.

To build such an integration, you will need the following OAuth scopes:

• r:awx_action:settings.account_details_view
• r:awx_action:balances_view
• w:awx_action:contact_management_edit
• w:awx_action:transfers_edit

To enable bill payments:

1. Check that the customer has sufficient funds in their account using the Get current balances API endpoint.
2. Create a beneficiary for the vendor with their payment details (e.g. bank account numbers), if you have not previously created one. Beneficiary records on Airwallex can be re-used across multiple payouts. Call Create a beneficiary API to do this — note that the fields required to create a beneficiary vary significantly across regions and destination bank account types, so you can use Get the API schema API endpoint to obtain the correct schema for a given region and destination bank account type combination.
3. Once you have a valid beneficiary, create the payout with the amount of the bill to be paid by calling Create a transfer API.
4. Sometimes the payout may be subject to additional review, in which case the status of the payout will not be immediately successful. To obtain the most up-to-date status of the payout, call Get a transfer by ID API with the Payout ID from the previous step.