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 Name	Description	Data Type/Format	Min-Max Length	Validation Criteria
`entity`	Unique ID given to you during the onboarding process.	AN	6	Must be six characters.
`quoteId`	Unique ID of the quote.	String	1-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 Name	Description	Data Type/Format
`entity`	Unique ID given to you during the onboarding process.	AN
`intent`	Payment method (intent) for which rates are retrieved.	AN
`quoteId`	Unique id of the quote.	AN
`sourceCurrency`	The currency code that is debited currency.	ISO 4217 Valid currency codes.
`targetCurrency`	The currency code that is credited currency.	ISO 4217 Valid currency codes.
`rateId`	Id of the rate request.	AN
`rate`	The quoted rate.	N
`quoteStartTime`	Datetime representation in UTC of when the quote starts.	datetime (UTC)
`quoteExpiryTime`	Datetime representation in UTC of when the quote expires.	datetime (UTC)
`status`	Status 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

Error	Message	Query	Scenario
`unauthorizedRequest`	The request is unauthorized		Unauthorised request
`forbidden`			Forbidden
`fieldIsMissing`	Missing QuoteId value	QuoteId	Missing quoteId
`notFound`			Wrong URL
`notFound`	Quote for given input does not exist		Quote does not exist
`internalErrorOccurred`	Something went wrong		Internal error

Next steps

Get FX rates
Create FX quote