The Mandate object

Description

Mangopay relies on the Mandate object to authorize direct debits to be collected from a user’s bank account on behalf of platforms.

The direct debit scheme of the Mandate is determined automatically by the Typeof the Bank Account: IBAN for the SEPA scheme and GB for the Bacs scheme.

Once created, the Mandate’s RedirectURL hosts a form that the user must confirm to authorize payments.

Attributes

SchemestringOptional

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.

BankAccountIdstringOptional

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.

BankReferencestringOptional

The banking reference for the Mandate.

CulturestringOptional

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.

DocumentURLstringOptional

The URL at which the mandate document can be downloaded.

ReturnURLstringOptional

Max. length: 220 characters

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

RedirectURLstringOptional

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.

IdstringOptional

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDateintegerOptional

Unix timestamp (UTC) of the date and time the object was created.

StatusstringOptional

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.

UserIdstringOptional

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

ExecutionTypestringOptional

Returned values: WEB

The execution type of the mandate.

MandateTypestringOptional

The type of the mandate.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

ResultCodestringOptional

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