​
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

​
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 corresponding Bank Account must belong to the BACS network (GB-type Bank Account) or SEPA network (IBAN-type Bank Account).
​
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, PLThe 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 charactersThe 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.
​
Id
string
The unique identifier of the object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
Status
string
Returned values: CREATED, SUBMITTED, ACTIVE, FAILED, EXPIREDThe 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: WEBThe execution type of the mandate.
​
Tag
string
Max. length: 255 charactersCustom 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.

Guide

Learn more about mandates and direct-debit

How to

How to process a SEPA Direct Debit payment