GoCardless Embed
Setting a scheme identifier
In this step of the GoCardless Embed guide, you will create a scheme identifier for a given creditor.
In order for your merchant's name to appear on their payers' bank statements, you will need to request custom scheme identifiers.
Different schemes have different scheme identifiers (e.g. SUNs in Bacs and CIDs in SEPA). Therefore you must request a scheme identifier for each scheme you plan to collect payments in.
Creating a scheme identifier
You can create a scheme identifier by performing a POST request to the /scheme_identifiers endpoint. The required parameters are:
Parameter | Description |
|---|---|
name | The name which will appear on the payer's bank statement. This will usually be the merchant's trading name. |
scheme | The scheme which this scheme identifier applies to. The supported schemes for the GoCardless Embed product are: |
links[creditor] | The ID of the creditor to link the scheme identifier to. Creditors start with 'CR' |
Examples of how to make this request using the GoCardless client libraries:
1POST https://api.gocardless.com/scheme_identifiers HTTP/1.1
2Content-Type: application/json
3{
4 "scheme_identifiers": {
5 "name": "The Wine Club",
6 "scheme": "bacs",
7 "links": {
8 "creditor": "CR123"
9 }
10 }
11}
12
13HTTP/1.1 201 Created
14Location: /scheme_identifiers/SU123
15Content-Type: application/json
16{
17 "scheme_identifiers": {
18 "id": "SU123",
19 "created_at": "2021-01-23T13:44:19.006Z",
20 "name": "The Wine Club",
21 "scheme": "bacs",
22 "status": "pending",
23 "currency": "GBP",
24 ...
25 },
26}For more details, see the API reference docs for creating scheme identifiers.
Scheme identifier status
The scheme identifier status will be pending while GoCardless is processing the request. Once the scheme identifier is ready to be used the status will be updated to active. At this point, GoCardless will emit a scheme identifier activated event via webhook to notify you of this change.
In Bacs, it will take up to five working days for a scheme identifier to become active. On other schemes, including SEPA, this happens instantly.