Skip to content
APIs/FX/
Create FX quote

Create FX quote

Request

Lock the FX rate for a specific currency pairing.
For Account Payouts customers only.

Security
basicAuth
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
Bodyapplication/vnd.worldpay.foreignexchange-v1+json
entitystringrequired

6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process

Example:"100001"
intentstringrequired

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

Enum:"PAYOUT""FX DEAL""MULTI-CURRENCY PRICING""CONSUMER RATES""PAYOUT LIVE RATE"
sourceCurrencystringrequired

The debit currency.

Example:"USD"
targetCurrencystringrequired

The credit currency.

Example:"EUR"
{
  "entity": "100001",
  "intent": "PAYOUT",
  "sourceCurrency": "USD",
  "targetCurrency": "EUR"
}

Responses

OK response if the request is valid

Bodyapplication/vnd.worldpay.foreignexchange-v1+json
entitystring

6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.

Example:"100001"
intentstring

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

Example:"PAYOUT"
quoteobject

A collection of account statement items.

Response
{
  "entity": "100001",
  "intent": "PAYOUT",
  "quote": {
    "quoteId": "Q000000001",
    "sourceCurrency": "EUR",
    "targetCurrency": "GBP",
    "rateId": "12345678",
    "rate": "1.2345",
    "quoteExpiryTime": "2025-01-10T12:00:00.000Z"
  }
}