Manage Linked Accounts
You can perform the following operations on Linked Accounts once you create them.
Update your Linked Account
You can update your Linked Account by adding a new signed mandate or renewing an existing mandate. Authorization from the external bank account owner in the form of a mandate (or signed agreement) is required before initiating direct debits. For more information, see Add funds via direct debits from Linked Accounts.
Call Update a direct debit mandate API to submit a signed mandate for direct debits if you didn't provide one when creating the Linked Account.
Provide the following parameters in the request:
email
: Email of the signatory. A pdf copy of the mandate will be sent to this email address.signatory
: Name of the mandate’s signatory. This should be the external account owner.type
: Payment methods in different regions. Possible values are:AU_BECS_DEBIT
,US_ACH_DEBIT
,GB_BACS_DEBIT
,EU_SEPA_DEBIT
,CA_EFT_DEBIT
.version
: Version of the signed mandate
If the mandate is successfully updated, a mandate status of ACTIVE
will be returned. If the mandate has expired and needs an update, a mandate status of INACTIVE
will be returned. You can retrieve the mandate details anytime using Get a direct debit mandate API
Before updating direct debit mandates, please check direct debit mandate requirements.
Example request
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
Suspend a Linked Account
You can suspend the the link between your external bank account and your Airwallex account by calling Suspend a Linked Account API.
If your Linked Account has been authorized for direct debits, the mandate will be deactivated automatically to ensure funds can no longer be debited from the external bank account. The status of your Linked Account will transition to SUSPENDED.
A successful suspension returns true
else false
.
To reactivate this Linked Account, you will have to create a new Linked Account and go through the verification steps.
Example request
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.