API Documentation

The requests that you submit here will be handled in our sandbox.

The response is encoded in JSON. Upon successful completion of a request, the "status" field is set to "ok" while the "data" field contains the actual payload:

{
  "status": "ok",
  "data": {...}
}

This wrapping will be applied to all responses. The response classes that are defined in this documentation at each end point, therefore only show the inner, data carrying part.

Authorization

Your backend needs to authenticate itself to use our APIs. You can create the credentials in the gateway manager (see here):

apiIdentifier
This identifies your system on our platform and is tied to a set of permissions you are allowed to perform on our API. They usually include boarding of merchants, managing hardware, registering transactions and querying transaction.
apiSecretKey
This ensures that its really you who is using the apiIdentifier.

Credentials

You cannot use your credentials for live processing here.

API Endpoints

Please enter your API Credentials.
 

Can we help you?

If you cannot find your answer, contact us and we'll get in touch with you soon.

© Copyright 2017 Payworks GmbH. Legal.