--- title: "Create a creditor bank account" method: POST path: "/creditor_bank_accounts" tags: ["Creditor Bank Account"] --- # Create a creditor bank account `POST /creditor_bank_accounts` ## Request - Base URL: `https://api.gocardless.com` - URL: `https://api.gocardless.com/creditor_bank_accounts` - Auth: HTTP bearer Creates a new creditor bank account object. ## Headers - `GoCardless-Version` string, required ## Request body - object - `creditor_bank_accounts` object - `account_number` string, nullable: Bank account number - see [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details) for more information. Alternatively you can provide an `iban`. - `bank_code` string, nullable: Bank code - see [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details) for more information. Alternatively you can provide an `iban`. - `branch_code` string, nullable: Branch code - see [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details) for more information. Alternatively you can provide an `iban`. - `iban` string, nullable: International Bank Account Number. Alternatively you can provide [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details). IBANs are not accepted for Swedish bank accounts denominated in SEK - you must supply [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details#sweden). - `country_code` string, nullable: [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). Defaults to the country code of the `iban` if supplied, otherwise is required. - `currency` string, nullable: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. - `account_holder_name` string, required: Name of the account holder, as known by the bank. Usually this is the same as the name stored with the linked [creditor](https://docs.gocardless.com/docs/api-reference/creditor). This field will be transliterated, upcased and truncated to 18 characters. - `account_type` 'savings' | 'checking', nullable: Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank accounts in other currencies. See [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states) for more information. - `set_as_default_payout_account` boolean: Defaults to `true`. When this is set to `true`, it will cause this bank account to be set as the account that GoCardless will pay out to. - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters. - `links` object, required - `creditor` string, required: ID of the [creditor](https://docs.gocardless.com/docs/api-reference/creditor) that owns this bank account. ## Response `201` Resource created successfully - CreditorBankAccountSingleResourceResponse - `creditor_bank_accounts` CreditorBankAccount: Creditor Bank Accounts hold the bank details of a [creditor](https://docs.gocardless.com/docs/api-reference/creditor). These are the bank accounts which your [payouts](https://docs.gocardless.com/docs/api-reference/payout) will be sent to. Note that creditor bank accounts must be unique, and so you will encounter a `bank_account_exists` error if you try to create a duplicate bank account. You may wish to handle this by updating the existing record instead, the ID of which will be provided as `links[creditor_bank_account]` in the error response.

Restricted: This API is not available for partner integrations.

- `id` string: Unique identifier, beginning with "BA". - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created. - `account_holder_name` string: Name of the account holder, as known by the bank. Usually this is the same as the name stored with the linked [creditor](https://docs.gocardless.com/docs/api-reference/creditor). This field will be transliterated, upcased and truncated to 18 characters. - `account_number_ending` string, nullable: The last few digits of the account number. Currently 4 digits for NZD bank accounts and 2 digits for other currencies. - `account_type` 'savings' | 'checking', nullable: Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank accounts in other currencies. See [local details](https://docs.gocardless.com/docs/api-reference/local-bank-details#united-states) for more information. - `country_code` string, nullable: [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). Defaults to the country code of the `iban` if supplied, otherwise is required. - `currency` string, nullable: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. - `bank_name` string, nullable: Name of bank, taken from the bank details. - `enabled` boolean: Boolean value showing whether the bank account is enabled or disabled. - `metadata` CustomerMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters. - `links` CreditorBankAccountLinks - `creditor` string: ID of the [creditor](https://docs.gocardless.com/docs/api-reference/creditor) that owns this bank account. - `verification_status` 'pending' | 'in_review' | 'successful' | 'could_not_verify': Verification status of the Bank Account. Can be one of `pending`, `in_review` or `successful` ## Other responses - `400`: Bad Request - `401`: Unauthorised - `404`: Not found - `422`: Validation Error - `500`: Internal Error --- [API](https://skmtc.dev/gocardless/apis/gocardless-api.md) - [All operations](https://skmtc.dev/gocardless/apis/gocardless-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gocardless/apis/gocardless-api/revisions/4dd3dae45364?raw)