Last Updated: 22 July 2024 | Change Log

Retrieve an FX quote

Account Payout customers only

Retrieving an existing FX quote.


Get Started

Start using our FX API by setting your headers.

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

Request

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

Example query string

GET https://try.access.worldpay.com/foreignExchange/quote/foreignExchange/quote?Entity=000055&QuoteId=Q0000000RH

Mandatory string parameters

Field NameDescriptionData Type/FormatMin-Max LengthValidation Criteria
entityUnique ID given to you during the onboarding process.AN6Must be six characters.
quoteIdUnique ID of the quote.String1-50

Response

Successful response example

{
    "entity": "000055",
    "intent": "PAYOUT",
    "quote": {
        "quoteId": "Q0000000RH",
        "sourceCurrency": "EUR",
        "targetCurrency": "ARS",
        "rateId": "R139884",
        "rate": 62.83084438,
        "quoteStartTime": "2024-07-23T06:41:15.773Z",
        "quoteExpiryTime": "2024-07-24T23:59:59.999Z",
        "status": "Active"
    }
}

Successful response fields

Field NameDescriptionData Type/Format
entityUnique ID given to you during the onboarding process.AN
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
quoteStartTimeDatetime representation in UTC of when the quote starts.datetime (UTC)
quoteExpiryTimeDatetime representation in UTC of when the quote expires.datetime (UTC)
statusStatus of the quote.AN

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