TRtruelayer
Mandates

Get mandate

Returns a mandate with the stated ID.

This endpoint can be called either by the regular backend token or the mandate token for that mandate.

get/v3/mandates/{id}

Request

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

Path parameters

idstring required

ID of the Mandate

Response

Mandate

OR
OR

Example response

{
  "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"
      }
    }
  }
}

Changes

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