Mandates

View a Mandate

Changed on

View a Mandate

get/v2.01/{ClientId}/mandates/{MandateId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/mandates/{MandateId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

MandateIdstring required

The unique identifier of the mandate.

Response

Success

Schemestring

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.
RecipientIdstring

The unique identifier of the Recipient object on which the mandate is based. This property should be used by platforms integrating for the first time (and not the BankAccountId).

BankAccountIdstring

The unique identifier of the bank account. This property should not be used by platforms integrating for the first time – use the RecipientId instead.

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.

BankReferencestring

The banking reference for the Mandate.

Culturestring

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.

DocumentURLstring

The URL at which the mandate document can be downloaded.

ReturnURLstring

Max. length: 220 characters

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

RedirectURLstring

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.

Idstring

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

The unique identifier of the object.

CreationDateinteger

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

Statusstring

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.
UserIdstring

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

ExecutionTypestring

Returned values: WEB

The execution type of the mandate.

MandateTypestring

The type of the mandate.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

ResultCodestring

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.

ResultMessagestring

The explanation of the result code.

Changes