Retrieve an FX quote

Request

Retrieving an existing FX quote.
For Account Payouts customers only.

Security

basicAuth

Query

entitystring, <= 6 charactersrequired

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

Example:entity=100001

quoteIdstring, [ 1 .. 50 ] charactersrequired

Unique ID of the quote.

Example:quoteId=Q000000001

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/quote?entity=100001&quoteId=Q000000001' \
  -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

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 quote 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"
  }
}