Manage your direct debit payouts
Global Accounts with direct debit payout capabilities allow you to authorize payouts from your Wallet. To receive notifications on any status transitions of direct debit payouts deducted from your Wallet balance, you can subscribe to Direct debit payouts webhook events . Learn more on Direct debit payout statuses .
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 debit payouts 30 days in arrears of today of the end date will be returned.
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
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
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
Cancel a direct debit payout
If you want to cancel a direct debit payout in PENDING status, call Cancel direct debit by ID API by specifying the unique direct debit identifier (transaction_id) in the endpoint URL. Only GBP direct debit payouts in the United Kingdom can be canceled.
GBP direct debit payouts will first post in PENDING status for a few hours, and if it’s canceled during this time, your Wallet balance will not be affected. After the direct debit payout status becomes SETTLED, you must contact our Support team to dispute any unauthorized transactions.
Requests that specify direct debit payouts in any other region will return a 400 error with the code invalid_operation. See Supported regions and currencies to learn more about our direct debit payout capabilities.
For other direct debit payout statuses, see Review status codes.
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.