Skip to main content
POST
The cap is Yativo available. Pending and reserved funds cannot be withdrawn. An amount above available returns 422 with code: amount_exceeds_available and the current balance. payout_method_id must already appear on this customer’s GET …/payout-methods list. See Let a customer withdraw their sales.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Headers

Idempotency-Key
string
required

A unique string per request to ensure idempotent processing.

Path Parameters

customer_id
string
required

Body

application/json
amount
string
required

Decimal string in major units. Drawn from available. Fees come out of this amount.

Example:

"50.00"

payout_method_id
string

Saved destination from GET …/payout-methods. Defaults to the customer's default.

currency
string

Defaults to usd.

Example:

"usd"

speed
enum<string>
default:standard
Available options:
standard,
instant

Response

Withdrawal submitted

status
string
Example:

"success"

status_code
integer
Example:

201

message
string
Example:

"Withdrawal submitted"

data
object