GOgocardless
Scheme Identifier

List scheme identifiers

Returns a cursor-paginated list of your scheme identifiers.

get/scheme_identifiers

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.

creditorstring

Unique identifier, beginning with "CR".

Example:CR123

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "scheme_identifiers": [
    {
      "id": "SU123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "scheme": "bacs",
      "status": "pending",
      "minimum_advance_notice": 3,
      "currency": "EUR",
      "address_line1": "221B Baker Street",
      "address_line2": "Marylebone",
      "address_line3": "City of Westminster",
      "city": "London",
      "region": "Greater London",
      "postal_code": "NW1 6XE",
      "country_code": "GB",
      "email": "user@example.com",
      "phone_number": "+44 20 1234 1234"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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