POST
/api/v2/banking/quotationsPayout Step 1: create a quote for an existing payee.
Use this before external payouts. The returned Id is used as QuotationId in POST /api/v2/banking/payouts/check, and QuoteRequestId must be preserved for later payout steps when returned.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (query) | unknown | No |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| PayeeId | unknown | Yes | Local payee ID from the payee list endpoint. Local payee ID from GET /api/v2/banking/payees. |
| FromCurrency | string | Yes | Source currency to fund the payout from, for example GBP, EUR, or USD. Source currency to fund the payout from, for example GBP, EUR, or USD. |
| Amount | unknown | Yes | Payout amount. |
| FeeMethod | string | No | Fee handling method. The dashboard flow sends INCLUDED. Fee handling method. The accounts page uses INCLUDED. |
| BalanceId | string | No | Optional provider balance or budget ID to fund the payout from. Optional provider balance or Equals Money budget ID used as funding source. |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| IsAvailable | boolean | No | |
| UnavailableReason | string | No | |
| RetryAfterSeconds | unknown | No | |
| Id | string | No | Provider quote/order ID. Use this as QuotationId in POST /api/v2/banking/payouts/check. Provider quote/order ID. Use this as QuotationId in POST /api/v2/banking/payouts/check. |
| QuoteRequestId | string | No | Provider quote request ID. Pass this to payout initiate/create and to raw trade calls when required by the provider. Provider quote request ID. Pass this to payout initiate/create and raw trade calls when required. |
| Rate | string | No | |
| Fees | array of PayoutFeeDto | No | |
| ExpirationTime | string | No | |
| CreateTime | string | No |
400 — Bad Request
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
401 — Unauthorized
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
404 — Not Found
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X POST "https://{base_url}/api/v2/banking/quotations" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"PayeeId":"…","FromCurrency":"…","Amount":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.