Retrieve an FX quote

Retrieving an existing FX Quote.

Note

This service is available for use as part of the future enhancements to FX API in 2024.


Get FX Quote

Authorization: {your_credentials}
Accept: application/vnd.worldpay.foreignexchange-v1+json

Request

GET https://try.access.worldpay.com/foreignExchange/quote/

Query string parameters

/foreignExchange/quote?Entity=000055&QuoteId=Q0000000B6

Mandatory string parameters

Field NameDescriptionData Type/FormatMin-Max LengthValidation Criteria
entityUnique consumer ID given during the onboarding process. Indicates the consumer for whom the quote is for.String6-6
quoteIdUnique id of the quote.String1-50

Response

Successful response example

{
    "entity": "000055",
    "intent": "PAYOUT",
    "quote": {
        "quoteId": "Q0000000BV",
        "sourceCurrency": "EUR",
        "targetCurrency": "ARS",
        "rateId": "R1",
        "rate": 70.82084705,
        "quoteExpiryTime": "2023-04-24T23:59:59.000Z"
    }
}  

Successful response fields

Field NameDescriptionData Type/Format
entityConsumer for whom the quote is for.A
intentPayment method (intent) for which rates are retrieved.AN
quoteIdUnique id of the quote.AN
sourceCurrencyThe currency code that is debited currency.ISO 4217

Valid currency codes.
targetCurrencyThe currency code that is credited currency.ISO 4217

Valid currency codes.
rateIdId of the rate request.AN
rateThe quoted rate.N
quoteExpiryTimeDatetime representation in UTC of when the quote will expire.datetime (UTC)

Error response example

{
    "errorName": "urlContainsInvalidValue",
    "message": "The URL contains a value or values that are invalid",
    "validationErrors": [
        {
            "errorName": "fieldIsMissing",
            "message": "Missing QuoteId value",
            "queryParameter": "QuoteId"
        }
    ]
}

Error response codes

ErrorMessageQueryScenario
unauthorizedRequestThe request is unauthorizedUnauthorised request
forbiddenForbidden
fieldIsMissingMissing QuoteId valueQuoteIdMissing quoteId
notFoundWrong URL
notFoundQuote for given input does not existQuote does not exist
internalErrorOccurredSomething went wrongInternal error

Next steps


Get FX rates
Create FX quote