---
title: "View a Mandate"
method: GET
path: "/v2.01/{ClientId}/mandates/{MandateId}"
tags: ["Mandates"]
---

# View a Mandate

`GET /v2.01/{ClientId}/mandates/{MandateId}`

View a Mandate

## Path parameters

- `ClientId` string, required
- `MandateId` string, required

## Headers

- `Authorization` string, required

## Response `200`

Success

- MandateResponse
  - `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 <a href="/api-reference/bank-accounts/bank-account-object">Bank Account</a> `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](/api-reference/overview/data-formats): 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.
  - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
  - `CreationDate` integer — Unix timestamp (UTC) of the date and time 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 <a href="/errors/codes">handle errors</a> or for filtering purposes.
  - `ResultMessage` string — The explanation of the result code.

---

[API](https://skmtc.dev/mangopay/apis/api-reference.md) · [All operations](https://skmtc.dev/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mangopay/api-reference/revisions/fafbd0c69654/schema)