Create a Mandate

Note – Mandate expires after 1 hour

If not confirmed within 1 hour of the CreationDate, the Mandate expires with the error 001807 and a new one must be created.

Body parameters

BankAccountId

string

required

The unique identifier of the bank account.

Warning: The Bank Account Type must be IBAN for the SEPA scheme and GB for the Bacs scheme.

Culture

string

required

Allowed values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL

The language in which the mandate confirmation page is to be displayed. This value only applies to mandates with the SEPA Scheme.

ReturnURL

string

required

Max. length: 220 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.

Responses

Scheme

string

The scheme of the mandate, which is available once the mandate is submitted. The value can be one of the following:

BACS – Covers payments in the UK, in GBP only.
SEPA – Covers payments in the EU.

BankAccountId

string

The unique identifier of the bank account.

Warning: The Bank Account Type must be IBAN for the SEPA scheme and GB for the Bacs scheme.

BankReference

string

The banking reference for the Mandate.

Culture

string

Returned values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL

The language in which the mandate confirmation page is to be displayed. This value only applies to mandates with the SEPA Scheme.

DocumentURL

string

The URL at which the mandate document can be downloaded.

ReturnURL

string

Max. length: 220 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

RedirectURL

string

The URL to which to redirect the user to complete the payment.

Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.

string

The unique identifier of the object.

CreationDate

timestamp

The date and time at which the object was created.

Status

string

Returned values: CREATED, SUBMITTED, ACTIVE, FAILED, EXPIRED

The status of the mandate:

CREATED – The mandate has been generated but not yet confirmed.
SUBMITTED – The mandate has been confirmed and sent to the user’s bank, and can be used to request a direct debit pay-in.
ACTIVE – The mandate has been accepted by the user’s bank or successfully used to process a direct debit direct pay-in. Further pay-ins can be requested.
FAILED – The mandate has been canceled or otherwise failed, and can no longer be used for payments.
EXPIRED – No payment has been made against the mandate in the last 24 months. It can no longer be used for payments.

UserId

string

The unique identifier of the User (natural or legal) who owns the bank account.

ExecutionType

string

Returned values: WEB

The execution type of the mandate.

MandateType

string

The type of the mandate.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.

ResultCode

string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage

string

The explanation of the result code.

{
   "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
   "Type": "param_error",
   "Id": "277c7c4e-baf1-43f8-ba1d-d9f02d7939e2",
   "Date": 1727958031.0,
   "errors": {
       "Culture": "The requested language is not supported for this bank account"
   }
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "9d45b954-4eda-4247-b4e3-91027628ab22",
    "Date": 1690294898.0,
    "errors": {
        "Culture": "The requested language is not supported"
    }
}  

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses