API Reference

API versioning

By default, all requests to the configuration API receive the latest version of the REST API. Use the Accept header to request the latest version of the REST API.

Use this interactive topic to find detailed information on device and system configuration.

IPC Configuration APIs
 0.0.6 
OAS3

APIs will allow merchant/partner to configure pay point and pair it with payment device to perform transaction.

By default, all requests receive the latest version of the REST API. We encourage you to explicitly request this version via the Accept header. Example

"Accept: application/vnd.worldpay.ipc.config-v1+json"

Servers

Pay Point

Pay Point is the integration point for EPOS to make the transaction.

GET​/payPoints
The API returns details of one or more pay points
PUT​/payPoint
The API allows the registration or modification of the pay point configuration on IPC
DELETE​/payPoint​/{payPointId}
The API de-registers the pay point from IPC and archives pay point configuration.

Device

Payment device is connected to the pay point to serve payments.

GET​/devices
The API returns one or more registered devices.
DELETE​/device​/{deviceId}
The API deletes the unpaired device.

Device Pay Point Pair

Pairing allows IPC to route the request from the pay point to the payment device.

GET​/devicePayPointPairs
The API returns one or more devices and the reference of the paired pay point.
POST​/devicePayPointPair
The API creates a pairing of a device and a pay point.
DELETE​/devicePayPointPair​/{deviceId}
The API unpairs the payment device from pay point.

Profile

The Profile allows you to customize pay point behaviour.

GET​/profiles
The API returns one or more profiles
POST​/profile
The API allows you to create a profile.
DELETE​/profile​/{profileId}
API removes profile.

Schemas

DevicePayPointPair
Device
PayPoint
Profile
SupportedFeature
InteractiveMessageTimeouts