Log inGet started
Airwallex logo
Home
Online Payments
Treasury
Transactional FX
Payouts
Issuing
Scale
Open Banking
Developer Tools
API Reference
Home
Treasury
Overview
Introduction to TreasurySupported currencies and payments
Get started
Receive funds into your WalletRetrieve your depositsAuthorize direct debit payoutsRetrieve your direct debit payouts
Getting Started

Retrieve your direct debit payouts

Global Accounts with direct debit capabililties allow you to pay out funds from your Wallet. You can retrieve details of the direct debit payouts as described in the following sections.

Retrieve all direct debit payouts

You can retrieve direct debit payouts across all your Global Accounts using Get a list of Direct Debits API. Specify the time period (from_created_date, to_created_date) and the pagination parameters (page_num, page_size) to refine the results. If the time period is left unspecified or only the end date is specified, then direct debits 30 days in arrears of today or the end date will be returned.

Example request

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/direct_debits?from_created_date=2021-05-01&page_num=0&page_size=100&to_created_date=2021-05-31' \
--header 'Authorization: Bearer <your_bearer_token>'

Example response

{
  "has_more": false,
  "items": [
    {
      "amount": 12794.27,
      "created_at": "string",
      "currency": "USD",
      "debtor_name": "ABC",
      "global_account_id": "e412ea03-b6fa-4198-90ef-aaee64c4139c",
      "statement_ref": "5487287788",
      "status": "SETTLED",
      "transaction_id": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2"
    }
  ]
}

Retrieve details of a direct debit payout

If you want to retrieve details of a specific direct debit payout, call Get Direct Debit by ID API by specifying the unique Identifier for direct debit transaction (transaction_id) in the endpoint URL. You can retrieve the transaction_id from Get a list of Direct Debits API.

Example request

curl --request GET \
--url 'https://api-demo.airwallex.com/api/v1/direct_debits/<transaction_id>' \
--header 'Authorization: Bearer <your_bearer_token>'

Example response

{
  "amount": 12794.27,
  "created_at": "string",
  "currency": "USD",
  "debtor_name": "ABC",
  "global_account_id": "e412ea03-b6fa-4198-90ef-aaee64c4139c",
  "statement_ref": "5487287788",
  "status": "SETTLED",
  "transaction_id": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2"
}
On this page
  • Retrieve all direct debit payouts
  • Retrieve details of a direct debit payout