GOgocardless
Creditor Bank Account

List creditor bank accounts

Returns a cursor-paginated list of your creditor bank accounts.

get/creditor_bank_accounts

Request

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

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

gtstring date-time

Limit to records created after the specified date-time.

ltstring date-time

Limit to records created before the specified date-time.

gtestring date-time

Limit to records created on or after the specified date-time.

ltestring date-time

Limit to records created on or before the specified date-time.

creditorstring

Unique identifier, beginning with "CR".

Example:CR123
'true' | 'false'
OR
boolean

If true, only return enabled bank accounts. If false, only return disabled bank accounts.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "creditor_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",
      "enabled": true,
      "links": {
        "creditor": "CR123"
      },
      "verification_status": "successful"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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