POST/api/v2/banking/quotations

Payout 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

Request parameters
FieldTypeRequiredDescription
userId (query)unknownNo

Request body

application/json

Request body fields
FieldTypeRequiredDescription
PayeeIdunknownYesLocal payee ID from the payee list endpoint. Local payee ID from GET /api/v2/banking/payees.
FromCurrencystringYesSource 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.
AmountunknownYesPayout amount.
FeeMethodstringNoFee handling method. The dashboard flow sends INCLUDED. Fee handling method. The accounts page uses INCLUDED.
BalanceIdstringNoOptional 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

Response 200 fields
FieldTypeRequiredDescription
IsAvailablebooleanNo
UnavailableReasonstringNo
RetryAfterSecondsunknownNo
IdstringNoProvider 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.
QuoteRequestIdstringNoProvider 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.
RatestringNo
Feesarray of PayoutFeeDtoNo
ExpirationTimestringNo
CreateTimestringNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

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.