Scheme Identifier

Get a single scheme identifier

Retrieves the details of an existing scheme identifier.

get/scheme_identifiers/{scheme_identifier_id}

Request

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

Path parameters

scheme_identifier_idstring required

The scheme identifier id

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"
  }
}

Changes

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