worldline Direct
Sign up

The Direct API has been designed as a REST API. It uses the HTTP protocol as its foundation. Each resource is accessible under a clearly named URL and the HTTP response codes are used to relay status. HTTP Verbs like GET and POST are used to interact with the resources. To support accessibility by clients directly, as opposed to your server, our servers support cross-origin resource sharing. 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 our platform.

To help you get started the below documentation is richly annotated with ready to be used code examples for each of the SDKs as well as JSON examples. These examples can be used against our sandbox. If you haven’t already, please create an account now.

Server API

The server API enables merchants to access our platform functionality such as doing payments, starting hosted checkouts, creating tokens, and much more. All these calls require you to have a secret API key/secret pair that merchants can look up in the Back Office.

statusCode property

The field status that is returned reflects the status of an object that has the same meaning regardless of the underlying processing platform. The raw statusCode is also returned in the statusCode field as part of the statusOutput object. The value can also be found in the Back Office.


Our platform supports multiple captures. This means that a transaction can reach the PENDING_CAPTURE status, which requires a CapturePayment API call to initiate one or more captures. Each of these capture requests result in a new Captures object with its own ID that can be interacted with.


With tokenisation, you can store cardholder or bank account details of your customers on our platform at will. This enables you to re-use the data easily for recurring payments, which frees you from taking additional PCI-related security measures! You can also use it in order to facilitate the customer journey by presenting previously used cards. Use our API to create, update (with new card / bank account details) and delete tokens to be flexible for every of your business models that require recurring payments of any kind.

returnUrl required

The field returnUrl is required for all card transactions using the create payment API call. This is something we will change in one of our upcoming releases.

Was this page helpful?

Do you have any comments?

Thank you for your response.