Get conversion quote

Request a quote for converting currency between two of your accounts.

The quote includes:

  • Exchange rate
  • Destination amount after conversion
  • Validity period (expiresAt)
  • Quote type (type)

Quote Expiration:
expiresAt is the time until which the quote can be submitted (usually a minute or less, depending on the vendor). After expiresAt, execution is rejected. The validity period does not lock the rate.

Quote Type:
type is returned on the quote. It is not a request parameter.

  • executable: The rate is locked. Executing before expiresAt settles at the quoted rate
  • indicative: The rate may change, including before expiresAt. The sell amount is fixed. The buy amount may differ from the quoted destination amount on execution

Instruction Type:
Use instructionType to control whether the amount represents the source or destination side:

  • sell (default): The amount is the source amount you are selling
  • buy: The amount is the destination amount you want to buy

Requirements:

  • Both accounts must belong to your organization
  • Source and destination currencies must be different
  • Amount must be a positive number
Body Params
uuid
required

Source account ID

uuid
required

Destination account ID (must be different from fromAccount)

string
required

Amount to convert. Represents the source amount when instructionType is sell (default), or the destination amount when buy.

string
enum
Defaults to sell

Controls how the amount is interpreted:

  • sell: The amount is the source amount to sell (default)
  • buy: The amount is the destination amount to buy
Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json