Preview payout

Resolves a beneficiary and creates a short-lived payout preview. The returned id must be supplied in POST /payments/v1/payouts before expires_at.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a payout preview. The preview resolves the beneficiary only; amount and asset are submitted later in POST /payments/v1/payouts.

co_breb
object
required

COP Bre-B beneficiary details.

string
enum
required

Preview payout type (only CO_BREB is supported).

Allowed:
Headers
string

Idempotency key for the request.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json