v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Flow

Notify that web authorization is required for a payout

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.

post/entities/{entityDID}/flow/payouts/{payoutId}/authorization_required

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

payoutIdstring uuid required

Payout transfer ID

Request body

authorizationUrlstring uri required

Web URL where the customer must complete authorization

expiresstring date-time

Optional ISO timestamp when the URL expires (defaults to 1 hour)

Response

AuthorizationRequired accepted

messagestring

transferIdstring