API Reference
  1. Zenoz Payments API
  2. Monarch — Payouts

Create a payout (async)

post
https://cloud.zenoz.ai/v1/payouts

Create a payout from your server. The payout runs in the background.

Send a generic rail (rtp or oct); Zenoz picks how the payout is carried. An Idempotency-Key header is required, and retrying with the same key returns the original payout.

The call returns 202 with status accepted. Poll GET /v1/payouts/{id} until it reaches committed, settled or failed.

Authenticate with an API key in X-API-Key. The key's tenant applies, and its prefix sets test or live.

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

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

Allowed:
string
required

Registered recipient id.

string
required

Reference to a pre-registered, tokenized destination instrument that holds the raw bank/card coordinates (routing number, account number, account type, or card token). Raw coordinates are captured once at instrument-registration time and are NEVER sent on the payout request. Must match the rail: a bank instrument for rtp, a card token for oct.

integer
required
≥ 1
string
required
length between 3 and 3
string

Your own id; echoed back and on status.

string

Optional Zenoz merchant id to attribute this payout to. When set (and valid for your tenant), the committed payout is mirrored into the transactions report under that merchant. Omit for a tenant-level payout (processes normally; not shown in the merchant transactions report).

Headers
string
required

Unique per payout; a retry returns the original payout.

Responses

Updated 21 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago

Did this page help you?