GoCardless API API Documentation
Create a Creditor
POST {{url}}/creditors
Creates a new creditor. Restricted: This endpoint is restricted to customers using the GoCardless Embed product. Partners should instead manage multiple merchant accounts by building a partner integration.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"creditors": {
"id": "CR00007SRS79RW",
"created_at": "2024-03-22T21:46:02.937Z",
"name": "Example Ltd",
"address_line1": null,
"address_line2": null,
"address_line3": null,
"city": null,
"region": null,
"postal_code": null,
"country_code": "GB",
"creditor_type": "company",
"logo_url": null,
"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": "0K7A9WZKMM",
"created_at": "2014-03-31T10:22:05.789Z",
"name": "GoCardless Ltd",
"scheme": "bacs",
"reference": "275069",
"status": "active",
"minimum_advance_notice": 3,
"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": "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": "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": "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": null,
"mandate_imports_enabled": false,
"custom_payment_pages_enabled": true,
"merchant_responsible_for_notifications": false,
"bank_reference_prefix": "EXAMPLELTD",
"links": {
"default_gbp_payout_account": "BA000ZP65F49P5",
"default_eur_payout_account": "BA000ZP65E9N8B",
"default_sek_payout_account": "BA000ZP65H6NSF",
"default_aud_payout_account": "BA000ZP65BZG1V",
"default_dkk_payout_account": "BA000ZP65DE1G9",
"default_nzd_payout_account": "BA000ZP65GA7C0",
"default_cad_payout_account": "BA000ZP65CCF7R",
"default_usd_payout_account": "BA000ZP65JZVD5"
}
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/creditors' -d '{"creditors":{"name":"Example Ltd","creditor_type":"company","country_code":"GB"}}'
ENDPOINTS