GOgocardless
Customer Bank Account

Create a customer bank account

Creates a new customer bank account object.

There are three different ways to supply bank account details:

For more information on the different fields required in each country, see local bank details.

<p class="restricted-notice"><strong>Restricted</strong>: this endpoint requires approved [custom payment pages](https://support.gocardless.com/hc/en-gb/articles/115004521925-Custom-Payment-Pages).</p> <p class="notice"><strong>Note</strong>: this endpoint is a legacy API endpoint and does not support GoCardless' newest features. We recommend using the [Billing Requests API](https://docs.gocardless.com/docs/collect-payments/setting-up-mandates) instead.</p>
post/customer_bank_accounts

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "customer_bank_accounts": {
    "account_number": "55779911",
    "branch_code": "20-00-00",
    "iban": "GB60BARC20000055779911",
    "country_code": "GB",
    "currency": "EUR",
    "account_holder_name": "Billie Jean",
    "account_type": "savings"
  }
}

Response

Resource created successfully

Example response

{
  "customer_bank_accounts": {
    "id": "BA123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "account_holder_name": "Billie Jean",
    "account_number_ending": "1234",
    "account_type": "savings",
    "country_code": "GB",
    "currency": "EUR",
    "bank_name": "BARCLAYS BANK PLC",
    "bank_account_token": "bat_f975ab3c-ecee-47a1-9590-5bb1d56fa113",
    "enabled": true,
    "trusted_recipient": true,
    "payer_name_verification_result": "full"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.