---
title: "Get mandate constraints"
method: GET
path: "/v3/mandates/{id}/constraints"
tags: ["Mandates"]
---

# Get mandate constraints

`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`

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

## Path parameters

- `id` string, required: Unique ID for the mandate

## Response `200`

Constraints State

- GetConstraints
  - `valid_from` string, datetime: Start date time for which the consent remains valid using format `YYYY-MM-DDTHH:mm:ss.sssZ`
  - `valid_to` string, datetime: End date time for which the consent remains valid using format `YYYY-MM-DDTHH:mm:ss.sssZ`
  - `maximum_individual_amount` integer, required: A 'cent' value representing the maximum amount that can be specified in a payment instruction
  - `periodic_limits` object, required: The state of the constraints utilisation within each periodic limit defined in the mandate creation. There will always be at least 1 period state defined
    - `day` object: Utilisation of this mandate within the current day
      - `period_alignment` 'consent' | 'calendar', required: Specifies whether the period starts on the date of consent creation or lines up with a calendar. If the `period_alignment` is `calendar`, the limit is pro-rated in the first period to the remaining number of days.
      - `maximum_available_amount` integer, required: A 'cent' value representing the maximum cumulative amount that all successful payments can claim in the period. This might be less than the `maximum_amount` requested due to proration on calendar aligned periods.
      - `current_amount` integer, required: A 'cent' value representing the current cumulative amount that all successful payments have claimed in the period.
      - `start_date` string, date, required: The start date for the current period
      - `end_date` string, date, required: The end date for the current period, and start of the next period
    - `week` object: Utilisation of this mandate within the current week period
      - `period_alignment` 'consent' | 'calendar', required: Specifies whether the period starts on the date of consent creation or lines up with a calendar. If the `period_alignment` is `calendar`, the limit is pro-rated in the first period to the remaining number of days.
      - `maximum_available_amount` integer, required: A 'cent' value representing the maximum cumulative amount that all successful payments can claim in the period. This might be less than the `maximum_amount` requested due to proration on calendar aligned periods.
      - `current_amount` integer, required: A 'cent' value representing the current cumulative amount that all successful payments have claimed in the period.
      - `start_date` string, date, required: The start date for the current period
      - `end_date` string, date, required: The end date for the current period, and start of the next period
    - `fortnight` object: Utilisation of this mandate within the current fortnight period
      - `period_alignment` 'consent' | 'calendar', required: Specifies whether the period starts on the date of consent creation or lines up with a calendar. If the `period_alignment` is `calendar`, the limit is pro-rated in the first period to the remaining number of days.
      - `maximum_available_amount` integer, required: A 'cent' value representing the maximum cumulative amount that all successful payments can claim in the period. This might be less than the `maximum_amount` requested due to proration on calendar aligned periods.
      - `current_amount` integer, required: A 'cent' value representing the current cumulative amount that all successful payments have claimed in the period.
      - `start_date` string, date, required: The start date for the current period
      - `end_date` string, date, required: The end date for the current period, and start of the next period
    - `month` object: Utilisation of this mandate within the current month period
      - `period_alignment` 'consent' | 'calendar', required: Specifies whether the period starts on the date of consent creation or lines up with a calendar. If the `period_alignment` is `calendar`, the limit is pro-rated in the first period to the remaining number of days.
      - `maximum_available_amount` integer, required: A 'cent' value representing the maximum cumulative amount that all successful payments can claim in the period. This might be less than the `maximum_amount` requested due to proration on calendar aligned periods.
      - `current_amount` integer, required: A 'cent' value representing the current cumulative amount that all successful payments have claimed in the period.
      - `start_date` string, date, required: The start date for the current period
      - `end_date` string, date, required: The end date for the current period, and start of the next period
    - `half_year` object: Utilisation of this mandate within the current half-year period
      - `period_alignment` 'consent' | 'calendar', required: Specifies whether the period starts on the date of consent creation or lines up with a calendar. If the `period_alignment` is `calendar`, the limit is pro-rated in the first period to the remaining number of days.
      - `maximum_available_amount` integer, required: A 'cent' value representing the maximum cumulative amount that all successful payments can claim in the period. This might be less than the `maximum_amount` requested due to proration on calendar aligned periods.
      - `current_amount` integer, required: A 'cent' value representing the current cumulative amount that all successful payments have claimed in the period.
      - `start_date` string, date, required: The start date for the current period
      - `end_date` string, date, required: The end date for the current period, and start of the next period
    - `year` object: Utilisation of this mandate within the current year period
      - `period_alignment` 'consent' | 'calendar', required: Specifies whether the period starts on the date of consent creation or lines up with a calendar. If the `period_alignment` is `calendar`, the limit is pro-rated in the first period to the remaining number of days.
      - `maximum_available_amount` integer, required: A 'cent' value representing the maximum cumulative amount that all successful payments can claim in the period. This might be less than the `maximum_amount` requested due to proration on calendar aligned periods.
      - `current_amount` integer, required: A 'cent' value representing the current cumulative amount that all successful payments have claimed in the period.
      - `start_date` string, date, required: The start date for the current period
      - `end_date` string, date, required: The end date for the current period, and start of the next period

## Other responses

- `400`: Invalid Parameters
- `401`: Unauthenticated
- `403`: Forbidden
- `404`: Mandate Not Found

---

[API](https://skmtc.dev/truelayer/apis/payments-api-v3.md) - [All operations](https://skmtc.dev/truelayer/apis/payments-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/payments-api-v3/revisions/a7c585fc9b84?raw)
