Skip to main content
POST
Request a CODA mandate

Authorizations

x-api-key
string
header
required

Identifies the partner software. Issued by Codaclean. Required on every call, including POST /token.

Authorization
string
header
required

Identifies the user and their accounting firm. Send the idToken returned by POST /token as Authorization: Bearer <idToken>. Valid for 1 hour.

Path Parameters

customerId
string
required

Customer identifier (24-character hexadecimal string), as returned in id.

iban
string
required

IBAN of the bank account. Spaces are removed and letters are uppercased before use.

Body

application/json
connectorId
integer

Only needed when the call returned 422 connectorSelectionRequired: pick one of the returned candidates.

Response

Mandate request received.

Confirmation returned by actions that do not return a resource.

message
string
required