# FX

Manage Foreign Exchange.

__Authentication header__

  ```
    Authorization: {your_credentials}
  ```
  Replace `{your_credentials}` with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.
  <br /> <br />
  You **must** use the `Authorization` header for any request you send to our FX APIs.
  <br /><br />
  __Accept header__
  ```
    Accept: application/vnd.worldpay.foreignexchange-v1+json
  ```

We use the Accept header to identify which version of our API you are using.
You must use the Accept header for any request you send to our FX APIs.

<br /><br />
__DNS whitelisting__


Whitelist the following URLs:

* `https://try.access.worldpay-bsh.securedataplatform.com/` - Account Payouts customers only

* `https://access.worldpay-bsh.securedataplatform.com/` - MCP and Account Payouts customers


Please ensure you use DNS whitelisting, not explicit IP whitelisting. When
you make a request within Access Worldpay, you should always cache the
response returned.

Version: 1
Metadata:
  - catalog-list: true
  - business: ["Enterprise","Marketplaces"]
  - category: ["FX"]
  - generated: true

## Servers

Test (Try) - Account Payouts customers only
```
https://try.access.worldpay-bsh.securedataplatform.com
```

Live
```
https://access.worldpay-bsh.securedataplatform.com
```

## Security

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

[FX](https://worldpay-portal.eu.redocly.app/access/_bundle/products/fx/@v1/openapi.yaml)

## Other

### Get FX rates

 - [GET /foreignExchange/rates](https://worldpay-portal.eu.redocly.app/access/products/fx/openapi/other/getfxrates.md): Retrieve an FX rate for a particular payment method.

### Create FX quote

 - [POST /foreignExchange/quote](https://worldpay-portal.eu.redocly.app/access/products/fx/openapi/other/postfxquote.md): Lock the FX rate for a specific currency pairing. For Account Payouts customers only.

### Retrieve an FX quote

 - [GET /foreignExchange/quote](https://worldpay-portal.eu.redocly.app/access/products/fx/openapi/other/getfxquote.md): Retrieving an existing FX quote.For Account Payouts customers only.

### Create an external contract

 - [POST /foreignExchange/contract](https://worldpay-portal.eu.redocly.app/access/products/fx/openapi/other/postcontract.md): Create an external contract to lock a forward FX rate. For Account Payouts customers only.

### Activate or cancel contract

 - [PUT /foreignExchange/contract/{contractId}](https://worldpay-portal.eu.redocly.app/access/products/fx/openapi/other/putcontract.md): Enable a contract to use locked in FX rates in an Account Payout. For Account Payouts customers only.

### Add a markup to your FX rate

 - [PUT /foreignExchange/markup/{entity}](https://worldpay-portal.eu.redocly.app/access/products/fx/openapi/other/addmarkup.md): Adding a markup to an existing FX rate. For MCP customers only.

### Retrieve markup

 - [GET /foreignExchange/markup/{entity}](https://worldpay-portal.eu.redocly.app/access/products/fx/openapi/other/getmarkup.md): Retrieving an existing markup for a specific FX rate.For MCP customers only.