GoCardless API API Documentation
Get a single Creditor
GET {{url}}/creditors/{{creditor}}
Retrieves the details of an existing creditor.
List Creditors API Docs
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"creditors": {
"id": "CR00006C6DF0TD",
"created_at": "2021-05-07T09:26:23.972Z",
"name": "Ondooo",
"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/2ac6908b8f7d0acdc80ae47bcea0bbee.png",
"scheme_identifiers": [
{
"id": "SU0000130NYHD2",
"created_at": "2021-08-27T07:51:08.823Z",
"name": "Jemma Losh",
"scheme": "ach",
"reference": "00000000",
"status": "active",
"minimum_advance_notice": 1,
"can_specify_mandate_reference": true,
"currency": "USD",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@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": "SU0000130DVJJT",
"created_at": "2021-08-27T07:42:55.758Z",
"name": "Jemma Losh",
"scheme": "bacs",
"reference": "234567",
"status": "active",
"minimum_advance_notice": 3,
"can_specify_mandate_reference": true,
"currency": "GBP",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000130EXA02",
"created_at": "2021-08-27T07:43:58.625Z",
"name": "Jemma Losh",
"scheme": "becs",
"reference": "488290",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": true,
"currency": "AUD",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000130FKA6F",
"created_at": "2021-08-27T07:44:52.837Z",
"name": "Jemma Losh",
"scheme": "becs_nz",
"reference": "234789",
"status": "active",
"minimum_advance_notice": 2,
"can_specify_mandate_reference": true,
"currency": "NZD",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000130JNEFM",
"created_at": "2021-08-27T07:47:17.403Z",
"name": "Jemma Losh",
"scheme": "betalingsservice",
"reference": "23456789",
"status": "active",
"minimum_advance_notice": 6,
"can_specify_mandate_reference": true,
"currency": "DKK",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU000012SBJYMG",
"created_at": "2021-05-20T15:47:54.178Z",
"name": "Jemma",
"scheme": "faster_payments",
"reference": "00000",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": true,
"currency": "GBP",
"address_line1": "x",
"address_line2": null,
"address_line3": null,
"city": "x",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000130KQAPB",
"created_at": "2021-08-27T07:49:14.428Z",
"name": "Jemma Losh",
"scheme": "pad",
"reference": "2345678901",
"status": "active",
"minimum_advance_notice": 3,
"can_specify_mandate_reference": true,
"currency": "CAD",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@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": "SU0000130M9VDQ",
"created_at": "2021-08-27T07:50:22.216Z",
"name": "Jemma Losh",
"scheme": "sepa",
"reference": "DE5162600002101235",
"status": "active",
"minimum_advance_notice": 3,
"can_specify_mandate_reference": true,
"currency": "EUR",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000133945DT",
"created_at": "2022-01-10T16:41:44.896Z",
"name": "Jemma Losh",
"scheme": "sepa_credit_transfer",
"reference": "JemmaLosh",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": false,
"currency": "EUR",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
},
{
"id": "SU0000133AKXXA",
"created_at": "2022-01-10T16:41:45.262Z",
"name": "Jemma Losh",
"scheme": "sepa_instant_credit_transfer",
"reference": "JemmaLosh",
"status": "active",
"minimum_advance_notice": 0,
"can_specify_mandate_reference": false,
"currency": "EUR",
"address_line1": "X",
"address_line2": null,
"address_line3": null,
"city": "X",
"region": null,
"postal_code": "EC1V 7EN",
"country_code": "GB",
"email": "jlosh@gocardless.com",
"phone_number": "+44 20 7183 8674"
}
],
"verification_status": "successful",
"can_create_refunds": true,
"fx_payout_currency": "GBP",
"mandate_imports_enabled": true,
"custom_payment_pages_enabled": true,
"merchant_responsible_for_notifications": true,
"bank_reference_prefix": "ONDOOO",
"links": {
"default_sek_payout_account": "BA000F4WVBGDDD",
"default_gbp_payout_account": "BA000F4WV9WRBE",
"default_aud_payout_account": "BA000F4WVDT805",
"default_nzd_payout_account": "BA000F4WVETRX3",
"default_dkk_payout_account": "BA000F4WVCWAWA",
"default_cad_payout_account": "BA000F4WVF44VY",
"default_eur_payout_account": "BA000F4WVAXYPW",
"default_usd_payout_account": "BA000F4WVGPYEH"
}
}
} |
Curl
curl -X GET 'https://api-sandbox.gocardless.com/creditors/https://api-sandbox.gocardless.com'
ENDPOINTS