Skip to content
APIs/FX/
Get FX rates

Get FX rates

Request

Retrieve an FX rate for a particular payment method.

Security
basicAuth
Query
intentstring, [ 1 .. 50 ] characters

Transaction type (intention) for which rates should be retrieved.

Enum:"PAYOUT""FX DEAL""MULTI-CURRENCY PRICING""CONSUMER RATES""PAYOUT LIVE RATE"
entitystring, = 6 characters

For Multi-Currency Pricing customers, the entity is an MCP Account Identifier (PartyID- Merchant Company ID, Unique ID given to you during the onboarding process.) for which rates should be retrieved.

For Account Payout customers, the entity is a six-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.

Example:entity=100001
sourceCurrencystring, = 3 characters^[A-Z]*$

The transaction currency code. If not supplied, the response contains rates for all source currencies against the target currency.

Example:sourceCurrency=USD
targetCurrencystring, = 3 characters^[A-Z]*$

Your funding (settlement) currency code. If not supplied, the response contains rates for all target currencies against the source currency.

Example:targetCurrency=EUR
Headers
Acceptstringrequired
Example:application/vnd.worldpay.foreignexchange-v1+json
WP-CorrelationIdstring

Optional ID to trace requests, if not provided, it is generated.

Example:15cd16b2-7b82-41cb-9b11-21be9dacad88
curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/foreignExchange/rates?intent=PAYOUT&entity=100001&sourceCurrency=USD&targetCurrency=EUR' \
  -H 'Accept: application/vnd.worldpay.foreignexchange-v1+json' \
  -H 'WP-CorrelationId: 15cd16b2-7b82-41cb-9b11-21be9dacad88'

Responses

OK response if the request is valid

Bodyapplication/vnd.worldpay.foreignexchange-v1+json
ratesArray of objects

A collection of rates items.

Response
{
  "rates": [
    {
      "rateId": "R12345678",
      "intent": "PAYOUT",
      "sourceCurrency": "EUR",
      "targetCurrency": "GBP",
      "bidRate": 1.23456789,
      "askRate": 1.23456789,
      "entity": 100001,
      "issuedDate": "2025-01-01T12:00:00.000Z",
      "validFrom": "2025-01-10T12:00:00.000Z",
      "validTo": "2025-01-10T12:00:00.000Z"
    }
  ]
}