Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Response Object for quoting exchange rates.

exchange_rate_quotesobject<rate_detail>[]Required

Exchange rate details, specified as an array of object.

Items1 <= length <= 500

rate_detail properties

7 properties

base_amountobject<money>Required

The amount that needs to be converted. If this parameter was not passed in the request, the value of base_amount is considered as 1 by default.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

quote_amountobject<money>Required

The amount in desired currency after conversion.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

exchange_ratestringRequired

Conversion rate between the base and quote currencies. Includes markup if markup_percent is provided in the request.

Match^([0-9]+[.][0-9]+)$Length1 <= length <= 32

fx_idstringOptional

Unique identifier that links a quoted FX rate to an order. Must be passed in further API calls.

Match^[ -~]+$Length1 <= length <= 4000

expiry_timestring<date_time>Optional

The time until exchange_rate will be valid for settlement. It is represented in ISO 8601. The time is determined at the time of contract agreement.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

rate_refresh_timestring<date_time>Optional

The time at which new exchange rates will be available next for this currency pair. The frequency is determined at the time of contract agreement.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

update_timestring<date_time>Optional

The time at which the exchange rate was last updated. The time is represented in ISO 8601.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

Back to top

Response Object for quoting exchange rates.

exchange_rate_quotesobject<rate_detail>[]Required

Exchange rate details, specified as an array of object.

Items1 <= length <= 500

rate_detail properties

7 properties

base_amountobject<money>Required

The amount that needs to be converted. If this parameter was not passed in the request, the value of base_amount is considered as 1 by default.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

quote_amountobject<money>Required

The amount in desired currency after conversion.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

exchange_ratestringRequired

Conversion rate between the base and quote currencies. Includes markup if markup_percent is provided in the request.

Match^([0-9]+[.][0-9]+)$Length1 <= length <= 32

fx_idstringOptional

Unique identifier that links a quoted FX rate to an order. Must be passed in further API calls.

Match^[ -~]+$Length1 <= length <= 4000

expiry_timestring<date_time>Optional

The time until exchange_rate will be valid for settlement. It is represented in ISO 8601. The time is determined at the time of contract agreement.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

rate_refresh_timestring<date_time>Optional

The time at which new exchange rates will be available next for this currency pair. The frequency is determined at the time of contract agreement.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

update_timestring<date_time>Optional

The time at which the exchange rate was last updated. The time is represented in ISO 8601.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

Response Object for quoting exchange rates.

rate_detail properties

money properties

money properties

Back to top

On this page

On this page

Response Object for quoting exchange rates.

rate_detail properties

money properties

money properties

Back to top

On this page

Response Object for quoting exchange rates.

rate_detail properties

money properties

money properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Response Object for quoting exchange rates.

rate_detail properties

money properties

money properties

Back to top

On this page