API overview

The Worldline Acquiring API has been designed as a RESTful API and is described in an OpenAPI document. It uses the HTTP protocol as its foundation. Each resource is accessible under a clearly named URL, and HTTP response codes are used to relay the primary result to your requests. HTTP Methods like GET and POST are used to interact with the resources. We use JSON for all of our payloads, including error messages.

All these characteristics mean that you will be able to use standard off the shelf software to interact with Worldline. To make the integration even easier, Worldline also has SDKs that wrap the complete Acquiring API.

To help you get started, the API Reference is richly annotated with ready to be used JSON examples. These examples can be used against our pre-production environment. You can also download the OpenAPI document that describes our API on our API Reference.