Create a currency quote

Creates a quote for a given currency pair.

You can create a quote for either an internal currency exchange or an outbound payment. To create a quote for an internal currency exchange, set type.to to balance. For an outbound payment, use any of payment, multiple, or forward.

Once you've created a quote, you can create an order.

All quotes expire after 12 seconds.

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

required
object

Details about the source currency.

required
object

Details about the target currency.

settlementDate
required
string^20[0-9]{2}[0-2][0-9][0-3][0-9]$

The settlement date.

required
object

Details about the type of quote that you're creating.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

post/orders/quote
Request samples
application/json
{
  • "sourceCurrency": {
    },
  • "targetCurrency": {
    },
  • "settlementDate": "20221027",
  • "type": {
    }
}
Response samples
application/json
{
  • "orderId": "EABCDE6FGHI0",
  • "quoteRequestId": "USD-USD-5-5",
  • "settlement": {
    },
  • "quote": {
    }
}