Create a quote

post

https://api-sandbox.modulrfinance.com/api-sandbox-token/foreign-exchange/quotes

Creates a foreign exchange quote for a currency pair and returns the rate and the amounts the customer will sell and buy. Requests to Quotes are synchronous and do not move any money. To use the quoted rate, supply the returned quoteId as fx.quoteId when creating a payment, before expiryDateTime.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Details of quote request

customerId

string

required

length ≥ 1

ID of the customer the quote is priced for. The customer must be enabled for FX.

sellCurrency

string

enum

required

Currency the customer is selling, in ISO 4217 format

buyCurrency

string

enum

required

Currency the customer is buying, in ISO 4217 format

amount

number

required

Amount to quote in Major Currency Units - '1' = 1.00. Applies to the buy or sell currency depending on tradeSide.

tradeType

string

enum

required

Type of FX trade the quote is for

Allowed:

tradeSide

string

enum

required

Whether amount is expressed in the buy currency or the sell currency

Allowed:

Responses

201Quote

400Validation errors

403Caller does not have access to the customer

500Unexpected error