---
title: "Start authorization flow"
method: POST
path: "/v3/payouts/{id}/authorization-flow"
tags: ["Payouts"]
---

# Start authorization flow

`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`

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.

## Path parameters

- `id` string, required: Unique ID for the Payout

## Headers

- `Idempotency-Key` string
- `X-Forwarded-For` string
- `X-Device-User-Agent` string

## Request body

- StartPayoutAuthorizationFlow: An object representing the request to start a authorization flow for a specific payout
  - `redirect` object, required: Can the UI redirect the end user to a third-party page? For most providers, payment authorization is achieved by redirecting the user to their chosen provider's page, where they can sign in with their credentials and approve the payment. This field declares whether the UI is able to perform such a redirect.
    - `return_uri` string, url, required: During the authorization flow the end user might be redirected to another page (e.g. bank website, TrueLayer's Hosted Payment Page). This URL determines where they will be redirected back once they completed the flow on the third-party's website. `return_uri` must be one of the allowed `return_uri`s registered in TrueLayer's Console.

## Response `200`

Perform payout authorization action

- union
  - PayoutAuthorizationFlowStarted
    - `status` 'authorizing', required
    - `actions` object, required: Object representing the next actions, if any. Present when the authorization flow is yet to be completed
      - `next` PayoutAuthorizationFlowNextAction, required
        - `type` 'redirect', required
        - `uri` string, url, required: URL the end user must be redirected to.
  - PayoutAuthorizationFlowCompleted
    - `status` 'completed', required
    - `failure_reason` 'account_not_valid' | 'internal_error': Possible failure reasons: - `account_not_valid` - Either none or more than one personal account have been connected - `internal_error` - An internal error happened

## Other responses

- `400`: Invalid Parameters
- `401`: Unauthenticated
- `403`: Forbidden
- `409`: Conflict
- `422`: Idempotency-Key Reuse
- `500`: Unknown Error

---

[API](https://skmtc.dev/truelayer/apis/payments-api-v3.md) - [All operations](https://skmtc.dev/truelayer/apis/payments-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/payments-api-v3/revisions/a7c585fc9b84?raw)