Logo
GoCardless API API Documentation

List Scheme Identifiers

GET {{url}}/scheme_identifiers

Returns a cursor-paginated list of your scheme identifiers.

List Scheme Identifiers API Docs

 

Body PARAM

Key Datatype Required Description 
after
null Cursor pointing to the start of the desired set.
before
null Cursor pointing to the end of the desired set.
limit
null Number of records to return.
creditor
null Unique identifier, beginning with “CR”.



HEADERS

Key Datatype Required Description 




RESPONSES

status OK

{ "scheme_identifiers": [ { "id": "SU0000169FT5KX", "created_at": "2024-06-21T14:39:45.471Z", "name": "Your Company Name", "scheme": "bacs", "reference": "948284", "status": "active", "minimum_advance_notice": 3, "can_specify_mandate_reference": true, "currency": "GBP", "address_line1": "1600 Pennsylvania Ave NW", "address_line2": null, "address_line3": null, "city": "Washington", "region": "DC", "postal_code": "N1 2AG", "country_code": "GB", "email": "stodorov@gocardless.com", "phone_number": "+44 7500 560560" }, { "id": "SU0000147R7J67", "created_at": "2022-07-21T09:56:43.122Z", "name": "GoCardless", "scheme": "pay_to", "reference": "
Curl
curl -X GET 'https://api-sandbox.gocardless.com/scheme_identifiers?after=&before=&limit=&creditor='

ENDPOINTS