v1

latestOpenAPI 3.0.32026-07-2484569553.1 KB

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

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 the end-user's authentication experience based on their device type. If omitted, the User-Agent header will be used instead. This header is only considered if the authorization_flow object in the request body is specified.

Response

Perform payout authorization action