Create mandate

post

https://api.atlar.com/payments/v2/mandates

Create a new direct debit mandate.

Body Params

active

boolean

Set this to true if this mandate is already known by the bank. This is for example a good option if you're migrating a lot of mandates that you know are already active. The actual outcome of using this flag depends on the direct debit scheme, since all schemes work in slightly different ways. For example, for AUTOGIRO, it means that Atlar won't send the mandate prior to making the collection. For other schemes, it could have an effect on how quickly the collection can be executed.

scheme

string

enum

required

Direct debit payment scheme. Choose among:

SDD_CORE (SEPA Direct Debit Core)
SDD_B2B (SEPA Direct Debit B2B)
GB_DD_BACS (UK BACS Direct Debit)
AUTOGIRO (Swedish Bg AutoGiro)
CH_DD_LSV (Swiss Direct Debit LSV+)
CH_DD_BDD (Swiss Direct Debit BDD)

Allowed:

externalAccountId

string

required

The ID of the external account to which this mandate is associated with.

destinationAccountId

string

The ID of the destination account where money will be collected for this mandate. This is only required for AUTOGIRO mandates.

creditorReference

string

required

length between 1 and 35

The customer number that you have received from the bank. For AUTOGIRO this is your 6 digit customer number.

mandateReference

string

required

length between 1 and 35

A unique reference to the mandate that you have signed with the debtor. For AUTOGIRO this is used as payer number associated with the mandate and validated as 1-16 digits. For AUTOGIRO, this reference must not contain leading 0's.

signatureDate

date

The date that this mandate was signed by the end user.

externalId

string

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

metadata

object | null

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

Responses

201The created mandate.

400Bad request.