TRtruelayer
Payouts

Start authorization flow

Start the authorization flow for a payout.

This API can be called using the resource_token associated with the payout you are trying to fetch.

post/v3/payouts/{id}/authorization-flow

Request

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

Path parameters

idstring required

Unique ID for the Payout

Example:0cd1b0f7-71bc-4d24-b209-95259dadcc20

ID of the payout

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.

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

Example request

{
  "redirect": {
    "return_uri": "https://my-site.com/payout-return"
  }
}

Response

Perform payout authorization action

OR

Changes

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