H!HOPPA
POST/api/v2/banking/trades/quote

Get FX trade quote

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
AccountIdstringNo
BaseCurrencystringNo
QuoteCurrencystringNo
AmountunknownNo
Sidebuy | sellNoAllowed values: buy, sell. Allowed values: buy, sell.

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
QuoteIdstringNo
BaseCurrencystringNo
QuoteCurrencystringNo
AmountunknownNo
QuoteAmountunknownNo
ExchangeRateunknownNo
ProviderBankProviderNoIndicates which banking provider owns a resource
ExpiresAtstring (date-time)No

401 — Unauthorized

Response 401 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/trades/quote" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.