API Reference
Asset librariesConsole

Start authorization flow

post
https://api.truelayer-sandbox.com/v3/mandates//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.
📘

Endpoint path changes

All Payments API v3 endpoints now start with /v3/. The old endpoints still work, but you must use the new path for all new integrations.

Path Params
string
required

ID of the Mandate

Body Params
provider_selection
object
required

Can the UI render a provider selection screen?

redirect
object
required

Can the UI redirect the end user to a third-party page?

Configuration options are available to constrain if TrueLayer's Hosted
Payment Page should be leveraged.

consent
object

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.

Headers
string

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.

string

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

Required with a OAuth2 token.

string
enum
Defaults to application/json; charset=UTF-8

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json; charset=UTF-8
application/problem+json; charset=UTF-8

Updated about 1 month ago