KintsugiKintsugi

List bank mandate texts

GET/bank-mandates

Returns the latest published authorisation text for each direct debit scheme. Show the text to the user before they accept it. An empty list means no text is published yet. Any user of the organization, or an API key, may read it. A credential that reaches several organizations must send Organization-Id, Connection-Id, or Entity-Id.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Response

copyIdstringRequired

Identifier of this published text. Send it as mandateCopyId when saving a bank account, to record which text the user accepted.

schemestringRequired

The debit scheme the text covers: PAD (Canada), BACS (United Kingdom) or SEPA_CORE (EU-27). A scheme with no published text is absent. New schemes appear here as their countries open.

versionintegerRequired

Version of the text. It starts at 1 for each scheme.

bodystringRequired

The full authorisation text to show to the user.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

422

The request failed validation.

cURL
GET /bank-mandates
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Response
[
{
"copyId": "bmcp_12345",
"scheme": "PAD",
"version": 1,
"body": "body"
}
]
List bank mandate texts (2026-07-21) | Kintsugi API Reference