Manage your direct debit payout mandates
When providing your Global Account details, the external party will ask you to sign a mandate which authorizes them to deduct funds from your Wallet. This page describes how you can retrieve and manage direct debit mandates signed in the United Kingdom to payout in GBP. For all other currencies, contact the external party directly to obtain your direct debit payout mandates.
Retrieve all direct debit payout mandates
You can retrieve mandates set up against a specific Global Account using Get a list of direct debit payout mandates API. Specify the unique identifier of the Global Account (global_account_id) in the endpoint URL. You can also specify the mandate status (status) , time period (from_created_date, to_created_date) and the pagination parameters (page_num, page_size) to refine the results.
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 mandate
If you want to retrieve details of a specific direct debit payout mandate, call Get direct debit payout mandate by ID API by specifying the unique identifier of the Global Account (global_account_id) and the unique identifier of the mandate (mandate_id) in the endpoint URL. You can retrieve those unique identifiers from Get a list of direct debits API or Get a list of direct debit payout mandates 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 mandate
If you want to cancel an unauthorized mandate, call Cancel a direct debit payout mandate by ID API by specifying the unique identifier of the Global Account (global_account_id) and the unique identifier of the mandate (mandate_id) in the endpoint URL. This cancellation may impact the service you are receiving. We recommend telling the external party to prevent disruptions.
Once the mandate is canceled, any future direct debit payouts submitted under this mandate will be rejected. If there are payouts currently being processed, you can contact our Support team to submit a dispute after the transactions have settled in your Wallet.
Note that your direct debit payout mandate may also be canceled by the external party or when you close the Global Account associated with the mandate.
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.