GoCardless API API Documentation
List Creditors
GET {{url}}/creditors
Returns a cursor-paginated list of your creditors.
List Creditors 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. | |
created_at[gt]
|
null | Limit to records created after the specified date-time. | |
created_at[gte]
|
null | Limit to records created on or after the specified date-time. | |
created_at[lt]
|
null | Limit to records created before the specified date-time. | |
created_at[lte]
|
null | Limit to records created on or before the specified date-time. | |
limit
|
null | Number of records to return. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"creditors": [
{
"id": "CR0000796J2GYR",
"created_at": "2023-01-11T10:07:01.346Z",
"name": "Your Company Name",
"address_line1": null,
"address_line2": null,
"address_line3": null,
"city": null,
"region": null,
"postal_code": null,
"country_code": "GB",
"creditor_type": "individual",
"logo_url": "https://uploads-sandbox.gocardless.com/0da655627ab1be22d28c6c3006d1abd6.png",
"scheme_identifiers": [
{
"id": "SU000011QF0FME",
"created_at": "2019-05-07T14:55:04.408Z",
"name": "GoCardless",
"scheme": "ach",
"reference": "00000000",
"status": "active",
"minimum_advance_notice": 1,
"can_specify_mandate_reference": false,
"currency": "USD",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000113K6WGA",
"created_at": "2015-09-29T12:35:41.600Z",
"name": "GoCardless",
"scheme": "autogiro",
"reference": "3171634",
"status": "active",
"minimum_advance_notice": 8,
"can_specify_mandate_reference": false,
"currency": "SEK",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"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": "SU000011E9TRP2",
"created_at": "2018-03-28T16:25:48.549Z",
"name": "GoCardless",
"scheme": "becs",
"reference": "488299",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": false,
"currency": "AUD",
"address_line1": "Level 9",
"address_line2": "401 Collins Street",
"address_line3": null,
"city": "Melbourne",
"region": null,
"postal_code": "VIC 3000",
"country_code": "AU",
"email": "help@gocardless.com",
"phone_number": "+61 3 8375 9198"
},
{
"id": "SU000011HK9K00",
"created_at": "2018-09-13T13:20:26.964Z",
"name": "GoCardless",
"scheme": "becs_nz",
"reference": "1220559",
"status": "active",
"minimum_advance_notice": 2,
"can_specify_mandate_reference": false,
"currency": "NZD",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU000011GZP1SS",
"created_at": "2018-06-15T10:36:29.985Z",
"name": "GoCardless",
"scheme": "betalingsservice",
"reference": "09025677",
"status": "active",
"minimum_advance_notice": 6,
"can_specify_mandate_reference": false,
"currency": "DKK",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000126T6TE4",
"created_at": "2021-03-24T20:12:53.408Z",
"name": "GoCardless",
"scheme": "faster_payments",
"reference": "000000",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": false,
"currency": "GBP",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU000011KS8MGJ",
"created_at": "2018-11-06T12:48:09.886Z",
"name": "GoCardless",
"scheme": "pad",
"reference": "2185310000",
"status": "active",
"minimum_advance_notice": 3,
"can_specify_mandate_reference": false,
"currency": "CAD",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000147R7J67",
"created_at": "2022-07-21T09:56:43.122Z",
"name": "GoCardless",
"scheme": "pay_to",
"reference": "00000000",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": false,
"currency": "AUD",
"address_line1": "338-346 Goswell Road",
"address_line2": null,
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7LQ",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000112CA5TT",
"created_at": "2015-08-05T11:20:10.823Z",
"name": "GoCardless",
"scheme": "sepa",
"reference": "GB27ZZZSDDBARC0000007495895",
"status": "active",
"minimum_advance_notice": 3,
"can_specify_mandate_reference": false,
"currency": "EUR",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "SU0000112CA5TT@example.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU000013316FBT",
"created_at": "2021-12-06T11:45:47.477Z",
"name": "GoCardless",
"scheme": "sepa_credit_transfer",
"reference": "00000000",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": false,
"currency": "EUR",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+33 1 70 37 71 23"
},
{
"id": "SU00001332ZRCP",
"created_at": "2021-12-06T11:47:26.393Z",
"name": "GoCardless",
"scheme": "sepa_instant_credit_transfer",
"reference": "00000000",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": false,
"currency": "EUR",
"address_line1": "Sutton Yard",
"address_line2": "65 Goswell Road",
"address_line3": null,
"city": "London",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "help@gocardless.com",
"phone_number": "+33 1 70 37 71 23"
}
],
"verification_status": "successful",
"can_create_refunds": true,
"fx_payout_currency": "GBP",
"mandate_imports_enabled": false,
"custom_payment_pages_enabled": true,
"merchant_responsible_for_notifications": false,
"bank_reference_prefix": "WILLISAWESOM",
"links": {
"default_eur_payout_account": "BA000QXWJSJABR",
"default_sek_payout_account": "BA000QXWJVHJ1T",
"default_aud_payout_account": "BA000QXWJYM4K4",
"default_dkk_payout_account": "BA000QXWJW4XVE",
"default_nzd_payout_account": "BA000QXWJZWNZ2",
"default_cad_payout_account": "BA000QXWK0WY6E",
"default_usd_payout_account": "BA000QXWK1KV8V",
"default_gbp_payout_account": "BA000QXWJRB2DG"
}
}
],
"meta": {
"cursors": {
"before": null,
"after": null
},
"limit": 50
}
} |
Curl
curl -X GET 'https://api-sandbox.gocardless.com/creditors?after=&before=&created_at[gt]=&created_at[gte]=&created_at[lt]=&created_at[lte]=&limit='
ENDPOINTS