TRtruelayer
Mandates

Get mandate constraints

Retrieve the constraints defined on the mandate, as well as the current utilisation of those constraints within the periods.

get/v3/mandates/{id}/constraints

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/mandates/{id}/constraints
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.truelayer.com/connect/token scopes: mandates

Path parameters

idstring required

Unique ID for the mandate

Example:be6db706-68f1-4e9c-ab09-b83d8e3ea60d

ID of the Mandate

Response

Constraints State

valid_fromstring datetime

Start date time for which the consent remains valid using format YYYY-MM-DDTHH:mm:ss.sssZ

valid_tostring datetime

End date time for which the consent remains valid using format YYYY-MM-DDTHH:mm:ss.sssZ

maximum_individual_amountinteger required

A 'cent' value representing the maximum amount that can be specified in a payment instruction

Example response

{
  "valid_from": "2022-01-01T00:00:00.000Z",
  "valid_to": "2022-12-31T23:59:59.999Z",
  "periodic_limits": {
    "day": {
      "start_date": "2021-01-30",
      "end_date": "2021-02-06"
    },
    "week": {
      "start_date": "2021-01-30",
      "end_date": "2021-02-06"
    },
    "fortnight": {
      "start_date": "2021-01-30",
      "end_date": "2021-02-06"
    },
    "month": {
      "start_date": "2021-01-30",
      "end_date": "2021-02-06"
    },
    "half_year": {
      "start_date": "2021-01-30",
      "end_date": "2021-02-06"
    },
    "year": {
      "start_date": "2021-01-30",
      "end_date": "2021-02-06"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.