Australia (AU_PAYTO_DEBIT)

Onboarding entity: PayTo is only available to Australian entities that are onboarded to Airwallex Australia with a local Australian Bank Account

• Platforms must be Australian entities and onboarded to Airwallex Australia
• Platforms must also ensure that only customers that are Australian entities and onboarded to Airwallex Australia are allowed to set up PayTo

Industry: Industry restrictions apply. Please reach out to your Airwallex Account Manager for more information

PayTo settles 24/7 in real-time via the NPP clearing system, hence FASTER_DIRECT_DEBIT is not applicable.

The title should inform your customers that they are linking an external bank account to set up PayTo.

You must ask the external bank account owner for:

• If they wish to link via PayID
  • PayID (Email/Phone Number/ABN/ACN/ARBN/ARSN/Organisation ID)
• Or the following if they choose to enter bank account details:
  • Bank account name
  • Bank account number
  • BSB code
• Bank account owner's email address

The customers must be given a prompt to confirm that their bank account details are correct before submitting the Linked Bank Account.

The following text must be displayed:

This PayTo agreement enables you to link your bank account with Airwallex for direct debits. By submitting this direct debit request, you agree to the PayTo Service Agreement and authorize Airwallex, through its own financial institution, to debit your nominated account through PayTo any amount and frequency specified by you. You also confirm that you have the authority to link the nominated account. Contact [email protected] for help.

Upon submitting the Linked Bank Account, a notification will be triggered to your customer’s banking application for them to approve the PayTo request.

You should inform your customers that the PayTo request is pending their authorization.

Upon receiving a successful authorization, you should provide a confirmation page to your customers to inform them that PayTo has been successfully set up for the Linked Bank Account.

Referring to Linked Account requirements for direct debit, both BUSINESS and INDIVIDUAL Linked Account types are supported for PayTo in Australia.

Open Banking is the available verification method. Unlike Open Banking for other direct debit schemes, PayTo triggers a notification to the external bank account banking application for authorization. It does not open up a modal or require the Platform to redirect its customers to an external site to log in.

Creating a Linked Account with the following information will create a PayTo authorization to the Linked Account:

• request_id: A unique ID for this deposit request (should be a valid UUID)
• type: Type of Linked Account. Either AU_BANK or AU_PAYID is required
• If type is AU_BANK, provide the following information in the au_bank object:
  • account_name: Registered name of the external bank account. This name must be the name of the business onboarded or under one of its UBOs.
  • account_number: Bank account number
  • bsb: 6-digit BSB code
  • currency: AUD
  • entity_type: BUSINESS or INDIVIDUAL
• If type is AU_PAYID, provide the following information in the au_payid object:
  • payid: PayID value
  • account_identifier_type: The type of PayID; could be one of PHONE_NUMBER, EMAIL_ADDRESS, ABN, ACN, ARBN, ARSN, ORGANISATION_IDENTIFIER
  • currency: AUD
  • entity_type: BUSINESS or INDIVIDUAL
• mandate: Details about the mandate
  • email: Email of the signatory. A PDF copy of the PayTo agreement will be sent to this email address.
  • signatory: Name of the mandate’s signatory. This should be the external bank account owner.
  • type: AU_PAYTO_DEBIT
  • version: 1.0
  • preferred_reference: Description for the mandate, up to 140 characters. This will show up on the Payer's banking application.
  • controls object: Defines the characteristics of the mandate
    • amount_type: Determines if the PayTo payments are FIXED or VARIABLE. If FIXED, fixed_amount_per_transaction is required.
    • max_amount_per_transaction: The maximum amount that can be paid from the Linked Account per PayTo transaction.
      • Different payer banks have different restrictions on what is an acceptable max_amount_per_transaction. For instance, the Commonwealth Bank of Australia automatically rejects any amount above 25k AUD. We recommend that you ask for this information from the Payer when they set up the mandate, as this value varies across banks and not all banks publicly disclose it.
    • fixed_amount_per_transaction: The fixed amount that may be paid from the Linked Account, per transaction.
    • end_date: End date of the mandate arrangement after which the Linked Account will be suspended. If unspecified, the mandate will not expire.
    • schedule object: Determines the schedule for recurring transaction cycles under this mandate. If no schedule is provided, an unlimited number of transactions would be allowed.
      • period: The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH.
      • period_unit: Specifies the transaction frequency. One of DAY, WEEK, MONTH or YEAR.

Example request

If you are registered as a platform account, you can call this endpoint on behalf of your customers by specifying the open ID in the x-on-behalf-of header.

Example response

The submission of a Linked Account with a mandate object will trigger an authorization to the external bank account owner’s banking application, where they will accept or decline the PayTo agreement.

After creating the Linked Account, the Linked Account will go into a REQUIRES_ACTION status, with next_action = external_authorize, indicating that the customer should authorize the agreement on their external banking application. They have to respond to the request in 5 days before the authorization expires.

The status of the Linked Account will be updated through the Linked Account webhooks.

See table below for actions and respective webhook events and data:

Refer to Linked Account error codes below for the possible failure details when the Linked Account is in a FAILED or SUSPENDED status.

Before creating a PayTo deposit, please ensure that you have a sufficient funding limit by checking your available funding limit.

Next, follow the instructions outlined in Create a direct debit deposit. Please note that the direct debit deposit reference for PayTo should not exceed 280 characters.