> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 `Type`of the <a href="/api-reference/bank-accounts/bank-account-object">Bank Account</a>: `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

<ParamField body="Scheme" type="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.
</ParamField>

<ParamField body="BankAccountId" type="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).
</ParamField>

<ParamField body="BankReference" type="string">
  The banking reference for the Mandate.
</ParamField>

<ParamField body="Culture" type="string">
  **Returned values:** One of the supported languages in the <a href="/api-reference/overview/data-formats">ISO 639-1 format</a>: 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`.
</ParamField>

<ParamField body="DocumentURL" type="string">
  The URL at which the mandate document can be downloaded.
</ParamField>

<ParamField body="ReturnURL" type="string">
  Max. length: 220 characters

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

<ParamField body="RedirectURL" type="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.
</ParamField>

<ParamField body="Id" type="string">
  The unique identifier of the object.
</ParamField>

<ParamField body="CreationDate" type="Unix timestamp">
  The date and time at which the object was created.
</ParamField>

<ParamField body="Status" type="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.
</ParamField>

<ParamField body="UserId" type="string">
  The unique identifier of the User (natural or legal) who owns the bank account.
</ParamField>

<ParamField body="ExecutionType" type="string">
  **Returned values:** `WEB`

  The execution type of the mandate.
</ParamField>

<ParamField body="Tag" type="string">
  Max. length: 255 characters

  Custom data that you can add to this object.
</ParamField>

<ParamField body="ResultCode" type="string">
  The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
</ParamField>

<ParamField body="ResultMessage" type="string">
  The explanation of the result code.
</ParamField>

### Related resources

<CardGroup cols={2}>
  <Card title="Guide" href="/guides/payment-methods/banking/direct-debit">Learn more about mandates and direct-debit</Card>

  <Card title="How to" href="/guides/payment-methods/banking/direct-debit">How to process a SEPA Direct Debit payment</Card>
</CardGroup>