generateQuote (v1)

Generate a quote

Query POST tag:Internal CurrencyCloud Connector

Overview

Generate a quote for a given currency pair

POST (/internal/v1/quotes:generate-quote)

Request Body

Responses

200 OK

404 Not Found

500 Internal Server Error

Architecture

4 properties
debitCurrency string
required

ISO 4217 Alpha 3 currency code.

Match pattern: [A-Z]{3}
creditCurrency
required
amount object
required

The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78

Match pattern: -?[0-9]{1,14}(\.[0-9]{1,3})?
fixedAmountSide string
required

The side of the conversion that is fixed

Allowed values: DEBIT CREDIT
7 properties
debitAmount object
required

The estimated amount to be debited.

creditAmount object
required

The estimated amount to be credited.

feeAmount object

The fee charged for the currency exchange.

rate number
required

The rate at which the debit currency will be exchanged for the credit currency.

rateLastUpdated object <date-time>
required

The timestamp indicating when the exchange rate was last updated. Outdated rates may apply during system outages.

3 properties
code string
Allowed values: urn:plmr-internal:forex:connector:INVALID_INPUT urn:plmr-internal:forex:connector:AMOUNT_IS_TOO_SMALL urn:plmr-internal:forex:connector:CURRENCY_EXCHANGE_TIME_WINDOW_CLOSED
message string
params object
3 properties
code string
Allowed values: urn:plmr-internal:forex:connector:INVALID_INPUT urn:plmr-internal:forex:connector:AMOUNT_IS_TOO_SMALL urn:plmr-internal:forex:connector:CURRENCY_EXCHANGE_TIME_WINDOW_CLOSED
message string
params object