Create Exchange Rate Quote

Purpose:

The PayPal Exchange Rate Quote API enables businesses to dynamically display prices in multiple currencies by generating exchange rate quotes for currency pair.

Key Features:

FX Rate Guarantee: Guarantees exchange rates for a specified duration, ensuring stability and consistency in currency presentment scenarios.

Customizable Pricing: Provides flexible exchange rate options tailored to business needs, allowing customization through negotiated rates and dynamic pricing models to align with business requirements.

Provides functionality to source wholesale market rates with the addition of a percentage-based currency conversion fee. This enables the delivery of retail exchange rates without offering a rate guarantee.

FX Rate Revenue Markup: Offers merchants the flexibility to apply customized markups on exchange rates, allowing them to generate additional revenue from currency conversions. Enables businesses to define their own pricing strategies by setting adjustable markups based on transaction volume, customer segments, or market conditions, ensuring greater control over foreign exchange earnings while maintaining competitive pricing for end users.

Quote API Usage:

Need a Guaranteed Rate for a Certain Timeframe: Businesses want to lock in an exchange rate for a defined period to protect against market fluctuations and reduce the risk of FX volatility.

Offer Customers Stable, Upfront Pricing for a Limited Time: Displaying FX rates but ensuring the rate remains fixed for a short duration, allowing customers to complete their purchase without unexpected price changes.

Integrate with PayPal as Payment Processor for Real-Time Quoting Scenarios: Leveraging PayPal’s payment processing capabilities, ensuring seamless multi-currency support.

Sample Use cases: Multi-Currency Presentment, Real-Time Checkout Quotes, Subscription Pricing with Guaranteed Rate, Buy-Now-Price Guarantee for Cross-Border Seller.

POST /v2/pricing/quote-exchange-rates

Create Exchange Rate Quote

cURL

curl --request POST \
  --url https://api-m.sandbox.paypal.com/v2/pricing/quote-exchange-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_items": [
    {
      "base_currency": "<string>",
      "base_amount": "<string>",
      "quote_currency": "<string>",
      "markup_percent": "<string>",
      "fx_id": "<string>"
    }
  ]
}
'

200

{
  "exchange_rate_quotes": [
    {
      "base_amount": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "quote_amount": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "exchange_rate": "<string>",
      "fx_id": "<string>",
      "expiry_time": "<string>",
      "rate_refresh_time": "<string>",
      "update_time": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Body

application/json

Request Object for quoting exchange rates.

quote_items · Request object for exchange rate quote. · object[] · required

Parameters required to request an exchange rate, passed in the quote_items array:

• base_currency
• base_amount
• quote_currency
• markup_percent
• fx_id.

Required array length: 1 - 250 elements

Show child attributes

organization · string

Organization this managed account belongs to, in the partner's hierarchy, in the form of a path.

Required string length: 2 - 100

Pattern: ^\w{2,20}(\/\w{2,20})*$

Response

200

application/json

A successful request returns the HTTP 200 OK status code and a JSON response body that shows quote exchange rate details.

Response Object for quoting exchange rates.

exchange_rate_quotes · Response object for fx service exchange currency. · object[] · required

Exchange rate details, specified as an array of object.

Required array length: 1 - 500 elements

Show child attributes