Core Endpoints-Customer Bank Accounts

Number of APIs: 5

1. Create a Customer Bank Account

POST {{url}}/customer_bank_accounts

Please consider using the Billing Requests API instead of Customer Bank Accounts for any future integrations.

Creates a new customer bank account object.

There are three different ways to supply bank account details:

• Local details
• IBAN
• Customer Bank Account Tokens

Note: Customer bank accounts can be created with local or international bank details. You can find the different local bank detail formats, and how they should be used with the GoCardless API here.

Create a customer bank account API Docs

---

2. Update a Customer Bank Account

PUT {{url}}/customer_bank_accounts/{{customer_bank_acct}}

Updates a customer bank account object. Only the metadata parameter is allowed.

Update a customer bank account API Docs

---

3. Get a single Customer Bank Account

GET {{url}}/customer_bank_accounts/{{customer_bank_acct}}

Retrieves the details of an existing bank account.

Get a single customer bank account API Docs

---

4. Disable a Customer Bank Account

POST {{url}}/customer_bank_accounts/{{customer_bank_acct}}/actions/disable

Immediately cancels all associated mandates and cancellable payments.

This will return a disable_failed error if the bank account has already been disabled.

A disabled bank account can be re-enabled by creating a new bank account resource with the same details.

Disable a customer bank account API Docs

---

5. List Customer Bank Accounts

GET {{url}}/customer_bank_accounts

Returns a cursor-paginated list of your bank accounts.

List customer bank accounts API Docs

---