Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Mandates

Create mandate

Create a new direct debit mandate.

post/payments/v2/mandates

Request body

activeboolean

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'SDD_CORE' | 'SDD_B2B' | 'GB_DD_BACS' | 'AUTOGIRO' | 'CH_DD_LSV' | 'CH_DD_BDD' required

Direct debit payment scheme. Choose among: <ul>

<li><code>SDD_CORE</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-core-rulebook-and-implementation">SEPA Direct Debit Core</a>)</li> <li><code>SDD_B2B</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-b2b-rulebook-and-implementation">SEPA Direct Debit B2B</a>)</li> <li><code>GB_DD_BACS</code> (UK <a href="https://www.bacs.co.uk">BACS</a> Direct Debit)</li> <li><code>AUTOGIRO</code> (Swedish <a href="https://www.bankgirot.se/autogiro">Bg AutoGiro</a>)</li> <li><code>CH_DD_LSV</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit LSV+</a>)</li> <li><code>CH_DD_BDD</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit BDD</a>)</li> </ul>
externalAccountIdstring required

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

destinationAccountIdstring

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

creditorReferencestring required

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

mandateReferencestring required

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.

signatureDatestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

externalIdstring

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

metadataMetadata nullable

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.

Example request

{
  "scheme": "SDD_CORE",
  "externalAccountId": "ba0ad236-2904-4b01-8e85-a4ef3a73c353",
  "destinationAccountId": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
  "signatureDate": "2022-05-07",
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  }
}

Response

The created mandate.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

counterpartyIdstring required

The ID of the counterparty which owns this mandate.

externalAccountIdstring required

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

destinationAccountIdstring

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

connectionInstructionIdstring

The ID of the instruction that was sent to the bank where this mandate was included when it was created. Subsequent instructions, such as mandate cancellations, won't update this ID. It will always refer to the instruction which created the resource.

creditorReferencestring required

The customer number that you have received from the bank.

scheme'SDD_CORE' | 'SDD_B2B' | 'GB_DD_BACS' | 'AUTOGIRO' | 'CH_DD_LSV' | 'CH_DD_BDD' required

Direct debit payment scheme. Choose among: <ul>

<li><code>SDD_CORE</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-core-rulebook-and-implementation">SEPA Direct Debit Core</a>)</li> <li><code>SDD_B2B</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-b2b-rulebook-and-implementation">SEPA Direct Debit B2B</a>)</li> <li><code>GB_DD_BACS</code> (UK <a href="https://www.bacs.co.uk">BACS</a> Direct Debit)</li> <li><code>AUTOGIRO</code> (Swedish <a href="https://www.bankgirot.se/autogiro">Bg AutoGiro</a>)</li> <li><code>CH_DD_LSV</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit LSV+</a>)</li> <li><code>CH_DD_BDD</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit BDD</a>)</li> </ul>
mandateReferencestring required

A unique reference to the mandate that you have signed with the debtor.

signatureDatestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

status'CREATED' | 'PENDING_CANCELLATION' | 'PENDING_CANCELLATION_SUBMISSION' | 'CANCELLATION_SENT' | 'PENDING_SUBMISSION' | 'SENT' | 'ACCEPTED' | 'ACTIVE' | 'FAILED' | 'CANCELLED' | 'UNKNOWN' required
externalIdstring

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

metadataMetadata nullable

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.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "counterpartyId": "f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8",
  "externalAccountId": "ba0ad236-2904-4b01-8e85-a4ef3a73c353",
  "destinationAccountId": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
  "connectionInstructionId": "c1d6502c-07c7-4c77-bee5-963f9464c7d8",
  "source": {
    "id": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
    "organizationId": "605e26fc-4fce-495a-a92f-2c3592d7287e",
    "market": "GB",
    "type": "EXTERNAL_ACCOUNT",
    "identifiers": [
      {
        "type": "IBAN",
        "market": "GB",
        "number": "GB33BUKB20201555555555"
      }
    ],
    "routing": [
      {
        "type": "BIC",
        "number": "BUKBGB22XXX"
      }
    ]
  },
  "sourceHolder": {
    "type": "ENTITY",
    "id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
    "legalName": "Example Company GmbH",
    "address": {
      "country": "DE",
      "city": "Munich",
      "postalCode": "123456"
    }
  },
  "scheme": "SDD_CORE",
  "signatureDate": "2022-05-07",
  "status": "SENT",
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  },
  "version": 1,
  "etag": "version:3",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}