---
title: "Notify that web authorization is required for a payout"
method: POST
path: "/entities/{entityDID}/flow/payouts/{payoutId}/authorization_required"
tags: ["Flow"]
---

# Notify that web authorization is required for a payout

`POST /entities/{entityDID}/flow/payouts/{payoutId}/authorization_required`

Sends an AuthorizationRequired signal for a PAYOUT Flow transfer.
The responder provides a web `authorizationUrl` that the initiator should present to
the customer for approval. Optionally an `expires` ISO timestamp can be provided; if omitted,
a default TTL (1 hour) is applied by the server.

## Path parameters

- `entityDID` string, did, required — Decentralized Identifier (DID)
- `payoutId` string, uuid, required

## Request body

- object
  - `authorizationUrl` string, uri, required — Web URL where the customer must complete authorization
  - `expires` string, date-time — Optional ISO timestamp when the URL expires (defaults to 1 hour)

## Response `200`

AuthorizationRequired accepted

- object
  - `message` string
  - `transferId` string

## Other responses

- `400` — Bad Request - The server could not process the request due to a client error.
- `401` — Unauthorized - Authentication information is missing or invalid.
- `403` — Forbidden - The server understood the request but refuses to authorize it.
- `404` — Payout not found
- `500` — Internal Server Error - An unexpected condition was encountered on the server.

---

[API](https://skmtc.net/notabene/apis/notabene-api.md) · [All operations](https://skmtc.net/notabene/apis/notabene-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/notabene/notabene-api/versions/70056745a433/schema)