TRtruelayer
Payments

Start authorization flow

Start the authorization flow for a payment.

This API can be called:

  • using the resource_token associated with the payment you are trying to fetch;
  • using a backend bearer token.
post/v3/payments/{id}/authorization-flow

Request

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

Path parameters

idstring required

Unique ID for the Payment

Example:0afd1f6a-f611-48ce-9488-321129bb3a70

ID of the payment

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.

X-Forwarded-Forstring

Used to collect and record end-user IP address. The first IP address in the list will be used as the end-user IP address.

X-Device-User-Agentstring

Used to improve end-user's authentication experience based on device type. If omitted, the User-Agent header will be used instead.

Request body

scheme_selectionobject

Can your UI render a scheme selection screen?

For payments where you set scheme_selection as user_selected, your UI must be able to render a screen where the user can select their payments scheme.

This field is required for payments with user_selected scheme selection. For other scheme selection types, it's optional.

branch_selectionobject

Can your UI render a branch selection screen?

For payments where you set branch_selection as user_selected, your UI must be able to render a screen where the user can select their payments branch.

This field is required for payments with user_selected branch selection. For other branch selection types, it's optional.

user_account_selectionobject

Can your UI render a user account selection screen?

If the user has previously consented to saving their bank account details with TrueLayer, they can choose from their saved accounts to speed up following payments.

This field states whether your UI can render a selection screen for these saved accounts. If you omit this, the user isn't presented with this option.

Example request

{
  "provider_selection": {},
  "scheme_selection": {},
  "redirect": {
    "return_uri": "https://my-site.com/payment-return"
  },
  "form": {
    "input_types": [
      "text"
    ]
  },
  "consent": {},
  "user_account_selection": {}
}

Response

Payment

OR

Changes

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