Skip to main content
POST
Send a single payment to a saved beneficiary. Debits your wallet at the time of submission.
Requires Idempotency-Key header. Your wallet is charged immediately on submission.
/payout/simple works like POST /wallet/payout with beneficiary_details_id in place of payment_method_id. To fix the amount the customer receives (amount_type: "receive"), use /wallet/payout. Every payout goes through compliance checks before it’s sent. If you include an invoice, it’s reviewed with the payout, so make sure its total and beneficiary match. A payout that needs a closer look stays pending until the review is finished.

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.

Body

application/json
debit_wallet
string
required

The source wallet currency to debit (e.g. "USD", "EUR").

Example:

"USD"

amount
number
required

Amount to send in the debit wallet currency.

Example:

250

beneficiary_details_id
integer
required

The saved beneficiary payment method ID (from POST /beneficiaries/payment-methods).

customer_id
string
required

The customer the payout is for. If the beneficiary belongs to a customer, it must be that customer.

Example:

"da44a3e6-eb5d-429f-8d17-357aa5a6cdf2"

beneficiary_id
string

Optional. The beneficiary that owns the payment method.

quote_id
string<uuid>

A payout quote from POST /exchange-rate. Locks the rate and fees for 5 minutes and supplies the amount.

reference
string

Payment reference passed to the recipient's bank, up to 250 characters. Depending on the payout rail, it may be shortened or have unsupported characters removed. For example, ACH allows only 10 letters, numbers or spaces.

Maximum string length: 250
invoice
file

Supporting invoice: PDF, PNG or JPEG, up to 15 MB. Send the request as multipart/form-data to attach it.

invoice_url
string<uri>

Public http or https link to the supporting invoice, as an alternative to invoice.

Response

Payout initiated

status
string
status_code
integer
message
string
data
object