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

# Get authorization flow

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

Get 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

## Response `200`

Perform payout authorization action

- union
  - PayoutAuthorizationFlowCreated
    - `status` 'created', required
  - 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

- `401`: Unauthenticated
- `403`: Forbidden
- `404`: Authorization flow not found
- `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)