GoCardless API API Documentation
Create a Scheme Identifier
POST {{url}}/scheme_identifiers
Creates a new scheme identifier. The scheme identifier must be applied to a creditor before payments are taken using it. The scheme identifier must also have the Relative endpoint: status of active before it can be used. For some schemes e.g. faster_payments this will happen instantly. For other schemes e.g. bacs this can take several days.POST /scheme_identifiers
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"scheme_identifiers": {
"id": "SU000015CZYSGC",
"created_at": "2024-03-22T21:45:22.902Z",
"name": "The Wine Club",
"scheme": "bacs",
"reference": "000015CZYSGC",
"status": "active",
"minimum_advance_notice": 3,
"can_specify_mandate_reference": true,
"currency": "GBP",
"address_line1": null,
"address_line2": null,
"address_line3": null,
"city": null,
"region": null,
"postal_code": null,
"country_code": null,
"email": null,
"phone_number": null
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/scheme_identifiers' -d '{"scheme_identifiers":{"name":"The Wine Club","scheme":"bacs","links":{"creditor":"creditor"}}}'
ENDPOINTS