Create a payout

post

https://sandbox-api.omicloud.io/v1/payouts

Sends funds out to a destination the end user owns. OmiCloud
creates the transaction and submits it to the gateway; settlement is
reported by webhook and on the transaction.

Idempotency-Key is required on this endpoint. Payouts move real
money on retry, so OmiCloud refuses a payout request without one.

destination is typed. crypto_address is the only type in this
version; fiat rails will be added as new types without changing
existing callers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

string

required

^[0-9]+(\.[0-9]{1,8})?$

Decimal string. Up to 8 fractional digits. Never a float.

currency

string

required

network

string

paymentMethod

string

destination

required

Typed destination. Only crypto_address exists today.

gateway

string

Force a gateway. Omit to let OmiCloud route.

endUserId

string

operatorReference

string

length ≤ 128

description

string

length ≤ 140

Shown on the gateway's side where supported.

metadata

object

Headers

Omi-Version

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Dated API version, e.g. 2026-09-01. Omit to use the version your API
key is pinned to. Only one version exists today; send the header
anyway so upgrades are a one-line change.

Idempotency-Key

string

required

length ≤ 255

Required on payouts. Any string up to 255 characters, unique per
operator. Same key + same body → original response with
Idempotent-Replayed: true; same key + different body →
409 IDEMPOTENCY_KEY_REUSED. Keys are remembered for 24 h.

Responses

201Payout accepted by the gateway.

400The request is malformed or outside what any route can execute.

401Missing, malformed, revoked, or wrong-environment API key.

403The key lacks the scope, the operator is paused, or the gateway is not connected to this account.

409The Idempotency-Key was already used with a different body.

502The gateway failed or was unreachable. The transaction was created and is now declined; gatewayDetails carries what the gateway said.