Create an FX quote synchronously

post

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

Creates a quote, requests pricing from the provider service synchronously, and returns effective amounts and rate when pricing succeeds.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Quote creation payload

customerId

string

required

length ≥ 1

Customer whose pricing and limits apply to this quote

sourceEntityType

string

enum

Business domain of the originating entity; required when sourceEntityId is supplied

Allowed:

sourceEntityId

string

length between 0 and 10

Originating business object identifier; required when sourceEntityType is supplied

sellCurrency

string

enum

required

ISO 4217 currency code for the leg the customer is selling

buyCurrency

string

enum

required

ISO 4217 currency code for the leg the customer is buying

amount

number

required

Notional amount in major currency units, interpreted per tradeSide

tradeType

string

enum

required

FX product (e.g. SPOT)

Allowed:

tradeSide

string

enum

required

Whether the amount applies to the buy or sell currency leg

Allowed:

Responses

201Quote created with effective pricing

400Validation errors

403Customer is outside the caller's access groups

500Unexpected internal error or FX provider connection failure