Scheme Identifier

Create a scheme identifier

Creates a new scheme identifier. 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.

Scheme identifier name validations

The name field of a scheme identifier can contain alphanumeric characters, spaces and special characters.

Its maximum length and the special characters it supports depend on the scheme:

schememaximum lengthspecial characters allowed
bacs18 characters/ . & -
sepa70 characters/ ? : ( ) . , + & < > ' "
ach16 characters/ ? : ( ) . , ' + -
faster_payments18 characters/ ? : ( ) . , ' + -

The validation error that gets returned for an invalid name will contain a suggested name in the metadata that is guaranteed to pass name validations.

You should ensure that the name you set matches the legal name or the trading name of the creditor, otherwise, there is an increased risk of chargeback.

<p class="restricted-notice"><strong>Restricted</strong>: This endpoint is restricted to GoCardless Embed customers. Please [contact us](https://forms.gocardless.com/l/305971/2023-01-25/535t8n){:target="_blank"} if you are interested in using this product.</p>
post/scheme_identifiers

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "scheme_identifiers": {
    "scheme": "bacs",
    "links": {
      "creditor": "CR123"
    }
  }
}

Response

Resource created successfully

Example response

{
  "scheme_identifiers": {
    "id": "SU123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "scheme": "bacs",
    "status": "pending",
    "minimum_advance_notice": 3,
    "currency": "EUR",
    "address_line1": "221B Baker Street",
    "address_line2": "Marylebone",
    "address_line3": "City of Westminster",
    "city": "London",
    "region": "Greater London",
    "postal_code": "NW1 6XE",
    "country_code": "GB",
    "email": "user@example.com",
    "phone_number": "+44 20 1234 1234"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.