Accounts

Guide to integrate against Mode's accounts APIs

Mode's Accounts REST APIs allow you to easily query withdrawals that you make to your nominated external bank account for accounting and audit purposes.

Withdrawals are usually processed on a schedule (daily, weekly, monthly), but you can also choose to create a withdrawal outside of these schedules.

Endpoint
POST /v1/withdrawals/:id	Create a withdrawal.
GET /v1/withdrawals	Get a list of all withdrawals.
GET /v1/withdrawals/:id	Get a withdrawal.

Create a withdrawal

When creating a withdrawal, you should supply your merchantId so that we will be able to make the withdrawal to your nominated external bank account.

🚧

Eligibility

Withdrawals are only available once you've passed our internal eligibility scheme. This can be anywhere between 14 and 30 days after being activated on the Mode platform.

🚧

Fees

Withdrawals are only available when you have a balance of more than £1.50. Mode takes £1.50 in fees for performing this for you.

Query withdrawals

Querying withdrawals couldn't be simpler. You can get a list of all withdrawals, or by providing the id of the withdrawal to the endpoint above, you will get a particular withdrawal.