TRtruelayer
Mandates

List mandates

List all the mandates associated to the client used. This API must be called using a backend bearer token.

get/v3/mandates

Request

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

Query parameters

user_idstring

Unique ID for the User

Example:f9b48c9d-176b-46dd-b2da-fe1a2b77350c

ID of the user

cursorstring

Cursor used for pagination purposes that represents the first item of the page. Returned as next_cursor in the response payload of endpoints supporting pagination. Not required to access the first page of items.

Example:bWFuZGF0ZXM6MmUwNDk0MTMK
limitinteger

Maximum number of items included in the returned window. Should be greater than 0 and less than 50. If not set, a default of 25 is considered.

Example:30

Response

Mandates list

Example response

{
  "items": [
    {
      "id": "be6db706-68f1-4e9c-ab09-b83d8e3ea60d",
      "currency": "GBP",
      "beneficiary": {
        "merchant_account_id": "AB8FA060-3F1B-4AE8-9692-4AA3131020D0"
      },
      "provider_selection": {
        "filter": {
          "countries": [
            "GB"
          ],
          "release_channel": "general_availability",
          "customer_segments": [
            "retail"
          ],
          "provider_ids": [
            "mock-payments-gb-redirect"
          ],
          "excludes": {
            "provider_ids": [
              "ob-exclude-this-bank"
            ]
          }
        }
      },
      "user": {
        "id": "f9b48c9d-176b-46dd-b2da-fe1a2b77350c"
      },
      "constraints": {
        "valid_from": "2022-01-01T00:00:00.000Z",
        "valid_to": "2022-12-31T23:59:59.999Z"
      },
      "metadata": {
        "prop1": "value1",
        "prop2": "value2"
      },
      "sub_merchants": {
        "ultimate_counterparty": {
          "url": "https://truelayer.com",
          "mcc": "1234",
          "address": {
            "address_line1": "40 Finsbury Square",
            "address_line2": "The Gilbert",
            "city": "London",
            "state": "London",
            "zip": "EC2A 1PX",
            "country_code": "GB"
          }
        }
      }
    }
  ],
  "pagination": {
    "next_cursor": "bWFuZGF0ZXM6MmUwNDk0MTMK"
  }
}

Changes

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