Preview a recipient payout (tenant-scoped)

Get a quote for a payout to a saved recipient, before any money moves.

Send a generic rail (rtp or oct). Never send a provider name or provider-specific routing; Zenoz picks how the payout is carried. The response includes a preview token to pass to /commit.

In sandbox, payouts run against a simulator, so you can test a full payout without a real destination or KYC. An amountCents of 66600 always declines, for testing failures. production payouts are not available yet.

The tenant is taken from the URL. A different tenantId in the body returns 404.

Authenticate with a dashboard session token, or a payout_write API key in X-API-Key (create one with POST /v1/api-keys/payout; it is pinned to one merchant and expires within 90 days). A payout key acts only for its own merchant. A merchantId for another merchant, another merchant's recipient or payout, or a path tenantId other than the key's tenant all return 404. A znz_pt_ key sends only sandbox payouts and a znz_pl_ key only production payouts. Payouts made with a key record it as the actor. Merchant secret keys, publishable keys and agent_onboarding keys are refused.

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

Tenant identifier (UUID).

Body Params
uuid
uuid
required
string
enum
required

Generic payout rail. RTP = real-time bank push; OCT = push-to-card.

Allowed:
string
enum
required
Allowed:
integer
required
≥ 1
string
required
length between 3 and 3
Responses

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