Returns exactly what a payout with these parameters would cost: both fees, what the recipient receives, and the total debited from the account. Creates nothing, reserves nothing and is safe to call repeatedly — it exists so the amounts a user confirms are computed here rather than re-derived by the caller. Rounding a fee differently would produce a figure the create endpoint then refuses. The same request body as `POST /payouts`; the destination is optional here, since price does not depend on it.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
accountId |
path | string |
yes | Unique identifier of the account. |
Request body
application/json
· QuotePayoutRequest
· required
| Field | Type | Required | Description |
|---|---|---|---|
amount |
string |
yes | The amount you are sending. In `deducted` mode this is what leaves the account; in `add_on` mode it is what the recipient receives. |
country |
string |
yes | ISO 3166-1 alpha-2 country of the recipient. |
feeMode |
PayoutFeeMode |
yes | |
method |
PayoutMethod |
yes |
Responses
| Status | Body | Description |
|---|---|---|
200 |
PayoutQuote |
Quote computed. |
400 |
Error |
Invalid request, an unavailable route, an amount outside the route's limits, or fees that would leave the recipient nothing. |
403 |
Error |
Payouts are not enabled for this client. |
404 |
Error |
Account not found. |
Specification
This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.