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 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.

Relative endpoint: POST /scheme_identifiers

Create a Scheme Identifier API Docs

Request Body

{"scheme_identifiers"=>{"name"=>"The Wine Club", "scheme"=>"bacs", "links"=>{"creditor"=>"{{creditor}}"}}}

RESPONSES

status: Created

{"scheme_identifiers":{"id":"SU000015D02J2Q","created_at":"2024-03-22T21:45:47.149Z","name":"The Wine Club","scheme":"bacs","reference":"000015D02J2Q","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}}