TRtruelayer
Mandates

Start authorization flow

Start the authorization flow for a mandate.

This API can be called:

  • using the mandate_token associated with the Mandate you are trying to fetch; or
  • using a backend bearer token.
post/v3/mandates/{id}/authorization-flow

Request

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

Path parameters

idstring required

Unique ID for the mandate

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

ID of the Mandate

Headers

Idempotency-Keystring

An idempotency key to allow safe retrying without the operation being performed multiple times. The value should be unique for each operation (we strongly advise to use a UUID v4), with the same key being sent on a retry of the same request.

Tl-Signaturestring

A JWS with detached content, signed with your private key. See Request Signing.

Required with a OAuth2 token.

Request body

provider_selectionobject required

Can the UI render a provider selection screen?

consentobject

Can the UI capture the user's consent?

This field declares whether the UI supports the consent action, which is used to explicitly capture the end user's consent for initiating the payment. If it is omitted, the flow will continue without a consent action.

Example request

{
  "provider_selection": {},
  "redirect": {
    "return_uri": "https://my-site.com/mandate-return"
  }
}

Response

Mandate Authorization Flow

OR

Changes

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