Skip to main content
POST
cURL
Withdraw available balance to the organization’s verified payout account. amount is in cents (USD, minimum 1000 = $10). The payout is created in pending and settles to paid asynchronously as provider webhooks arrive.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Body

application/json
amount
integer
required
Required range: 1000 <= x <= 9007199254740991
description
string
Maximum string length: 500

Response

Success

id
string
required
status
enum<string>
required
Available options:
pending,
in_transit,
paid,
failed,
canceled
amount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
fee
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
netAmount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
currency
string
required
description
string | null
required
providerTransferId
string
required
createdAt
string<date-time>
required
object
string
required
Allowed value: "payout"
livemode
boolean
required