Skip to content
APIs/FX/
Retrieve markup

Retrieve markup

Request

Retrieving an existing markup for a specific FX rate.
For MCP customers only.

Security
basicAuth
Path
entitystring, <= 6 charactersrequired

MCP Account Identifier (PartyID- Merchant Company ID, unique 6-digit ID given to you during the onboarding process.) for which rates should be retrieved.

Example:100001
Query
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/markup/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
sourceCurrencystring

The debit currency.

Example:"EUR"
targetCurrencystring

The credit currency.

Example:"GBP"
paymentMethodstring

Payment method.

Example:"ENDCONSUMERRATES"
entitystring

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

Example:"100001"
valuestring

Markup value setup.

Example:"1.234"
Response
{
  "sourceCurrency": "EUR",
  "targetCurrency": "GBP",
  "paymentMethod": "ENDCONSUMERRATES",
  "entity": "100001",
  "value": "1.234"
}