**Last updated**: 05 June 2025 | [**Change log**](/products/fx/changelog/)

# Retrieve an FX quote

Account Payout customers only

Retrieving an existing FX quote.

## Get started

Start using our FX API by [setting your headers](/products/fx#set-your-headers).


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

## Request

`GET` `https://try.access.worldpay-bsh.securedataplatform.com/foreignExchange/quote/`

### Example query string

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

### Mandatory string parameters

| Field name | Description | Data type/format | Min-max length | Validation criteria |
|  --- | --- | --- | --- | --- |
| `entity` | 6-digit reference given to you by your Implementation Manager during the onboarding process. | AN | 6 | Must be six characters. |
| `quoteId` | Unique ID of the quote. | String | 1-50 |  |


## Response

### Successful response example

{
  "entity": "000696",
  "intent": "PAYOUT",
  "quote": {
    "quoteId": "Q000000BCS",
    "sourceCurrency": "EUR",
    "targetCurrency": "GBP",
    "rateId": "R42813061",
    "rate": 0.77182584,
    "quoteExpiryTime": "2025-03-24T16:07:38.406Z"
  }
}

### Successful response fields

| Field name | Description | Data type/format |
|  --- | --- | --- |
| `entity` | 6-digit reference given to you by your Implementation Manager during the onboarding process. | AN |
| `intent` | Transaction type (intention) for which rates should be retrieved. | AN |
| `quoteId` | Unique id of the quote. | AN |
| `sourceCurrency` | The currency code that is debited currency. | ISO 4217Valid [currency codes](/products/reference/supported-countries-currencies#iso-currency-codes). |
| `targetCurrency` | The currency code that is credited currency. | ISO 4217Valid [currency codes](/products/reference/supported-countries-currencies#iso-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 |  | Unauthorized 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](/products/fx/fxrate)
[Create FX quote](/products/fx/create-fxquote)