Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldpay ForeignExchange API

The ForeignExchange API from Worldpay — 5 operation(s) for foreignexchange.

Worldpay ForeignExchange API is one of 45 APIs that Worldpay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ForeignExchange. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.0.1, at version 3.

Requests are made against 2 base URLs: https://try.access.worldpay.com, https://access.worldpay.com.

7 operations 5 paths 19 schemas 3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3
Base URL
https://access.worldpay.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Worldpay ForeignExchange API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

ForeignExchange 7
GET
/foreignExchange/rates
Get FX rates
getFXrates 6 params → 200400401403404500
POST
/foreignExchange/quote
Create FX quote
postFXquote 2 params body → 200400401403404500
GET
/foreignExchange/quote
Retrieve an FX quote
getFXquote 4 params → 200401403404500
POST
/foreignExchange/contract
Create an external contract
postContract 2 params body → 200400401403404500
PUT
/foreignExchange/contract/{contractId}
Activate or cancel contract
putContract 3 params body → 204400401403404409500
PUT
/foreignExchange/markup/{entity}
Add a markup to your FX rate
addMarkup 3 params body → 204401403404500
GET
/foreignExchange/markup/{entity}
Retrieve markup
getMarkup 5 params → 200401403404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ExternalRateItems (10 properties), ExternalContractQuoteItems (8 properties), ExternalPostContractResponse (7 properties), ExternalQuoteItems (6 properties). Each schema is shown below with its type and property counts.

ExternalGetMarkupResponse
object
5 properties
ExternalPostQuoteResponse
object
3 properties
ExternalGetQuoteResponse
object
3 properties
ErrorResponse400
object
3 properties 3 required
postCreateContractItems
object
6 properties 5 required
ErrorResponse
object
2 properties 2 required
postCreateQuoteItems
object
4 properties 4 required
putMarkupRequestItems
object
3 properties 3 required
ErrorResponse400Contract
object
2 properties 2 required
ErrorResponse400QuoteItem
object
3 properties 3 required
ErrorResponse400Item
object
3 properties 3 required
ExternalPostContractResponse
object
7 properties
putActivatedContractItems
object
2 properties 2 required
ExternalContractQuoteItems
object
8 properties
ExternalRateItems
object
10 properties
ErrorResponse400Quote
object
3 properties 3 required
ExternalRateResponse
object
1 property
ExternalQuoteItems
object
6 properties
CurrencyCode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-foreignexchange-api-openapi.yml Raw ↑

Other APIs Worldpay publishes across the network.

Worldpay Tokens API
Worldpay Card Payouts API
Worldpay Account Payouts API
Worldpay FraudSight API
Worldpay 3DS API
Worldpay APMs API
Worldpay FX API
Worldpay Hosted Payment Pages API
Worldpay Events API
Worldpay Beneficiary Account Verifications API
Worldpay Split Payments API
Worldpay Statements API