API ReferenceCustomersAPI IntegrationQuotes

Create Quote

The quote defines the essential information for a transfer: the currencies involved, the amount to exchange, and the customer profile. This quote, along with recipient details, is required to create a payment transfer.

Authentication: Bearer token required

Path parameters

customer_idstringRequired
The unique identifier of the customer requesting the quote

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
sell_currencystringRequired=3 characters

Currency to sell in ISO 4217 Currency Codes three-letter format (e.g., GBP, USD, EUR). Must be different from buy_currency.

buy_currencystringRequired=3 characters

Currency to buy in ISO 4217 Currency Codes three-letter format (e.g., GBP, USD, EUR). Must be different from buy_currency.

amountdoubleRequired>=0.01

The monetary amount for the currency conversion, interpreted based on the fixed_side parameter.

Amount Interpretation

The meaning of this field depends on the fixed_side value:

  • When fixed_side: "BUY": Amount of buy_currency you want to receive
  • When fixed_side: "SELL": Amount of sell_currency you want to exchange

Practical Examples

BUY Side Fixed

1{
2  "buy_currency": "USD",
3  "sell_currency": "GBP", 
4  "amount": 1000.00,
5  "fixed_side": "BUY"
6}

Result: Quote to receive exactly 1,000 USD (you’ll pay the equivalent in GBP)

SELL Side Fixed

1{
2  "buy_currency": "USD",
3  "sell_currency": "GBP",
4  "amount": 1000.00, 
5  "fixed_side": "SELL"
6}

Result: Quote to sell exactly 1,000 GBP (you’ll receive the equivalent in USD)

Validation Rules

  • Minimum: 0.01 (one cent/penny equivalent)
  • Precision: Maximum 2 decimal places
  • Format: Standard decimal notation (e.g., 1000.50, not 1,000.50)

Quote Response Behavior

Fixed SideAmount Field RepresentsQuote Response Contains
BUYTarget amount to receiveAmount you need to pay
SELLSource amount to exchangeAmount you will receive
fixed_sideenumOptionalDefaults to SELL

Which side of the payment you want to fix. The default is SELL. See amount.

Options:

  • BUY: Fix the buy amount (you know exactly how much you want to receive)
  • SELL: Fix the sell amount (you know exactly how much you want to pay)

Default: SELL

Allowed values:

Response

A quotation was created and returned in the response body.
quote_idstringformat: "uuid"

Unique identifier for this quote.

Usage: Reference this ID when creating payments via Create Payment API

customer_idstring
Identifies which customer account owns this quote. Required when using this quote to create payments.
sell_currencystring

Currency you want to sell.

Format: 3-letter ISO 4217 currency code

buy_currencystring

Currency you want to buy.

Format: 3-letter ISO 4217 currency code

amountdouble

Amount you want to exchange. Note: If the fixed_side is ‘SELL’ (the default) this amount relates to the sell_currency. If the fixed_side is ‘BUY’ it relates to the buy_currency.

fixed_sideenum
Which side of the payment you want to fix. The default is SELL.
Allowed values:
quote_detailsobject

Errors