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

post/orders/quote

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"sourceCurrency": {"amount": 0,
"currency": {"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"currencyCode": "USD"
}
},
"targetCurrency": {"amount": 0,
"currency": {"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"currencyCode": "USD"
}
},
"settlementDate": "20221027",
"type": {"from": "bank",
"to": "payment",
"recipientId": "8lciyups6"
}
}

Response samples

application/json

{"orderId": "EABCDE6FGHI0",
"quoteRequestId": "USD-USD-5-5",
"settlement": {"date": "20221027",
"price": {"amount": 5,
"currency": "USD"
},
"charges": {"fee": 0,
"margin": 0,
"other": 0
}
},
"quote": {"rate": 1,
"inverseRate": 1,
"fromGbpAmount": 3,
"from": {"amount": 5,
"currency": "USD"
},
"to": {"amount": 5,
"currency": "USD"
},
"direction": 1
}
}