Communication from your server to our platform is performed by sending key-value-pairs via secure channel per HTTP Post request. In return, your application will receive a response string containing the result of your request. For sending the request to us, we recommend using a cURL wrapper that sends an array as key-value-pairs. The response are key value pairs delimited by EOL breaks, which can easily be parsed into an array.

Requirements

An active PAYONE - Account is required. If you do not have one yet, please contact us.

Communication Principles

Getting Started

Data transfer

In order to send data to Payone, the content type must be set to "application/x-www-form-urlencoded".

The data transfer is based on HTTPS-POST request (key/value pairs).

API Endpoint

The requests must be sent to the following URL:
API URL: https://api.pay1.de/post-gateway/.

POST: /post-gateway/ HTTP/1.1
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded

                mid=12345&aid=12345&portalid=1234567&key=a116ca816e9a312f27c57c2b96ddd319&request=authorization&mode=test&reference=pm-post-1635948362&currency=EUR&clearingtype=rec&lastname=PM-Tester&firstname=Paul&country=DE&amount=1000
            

Receiving Data from PAYONE

The return of the data is based on a line-by-line basis. The name of the parameter is separated from the parameter value with an equal sign ("=").

POST: /post-gateway/ HTTP/1.1
Host: api.pay1.de
User-Agent: "xxx x.x"
Content-Type: application/x-www-form-urlencoded charset=UTF-8
encoding=UTF-8&
parameter1=value1&
parameter2=value2&
...
        

How to Read Our Parameter Tables

Parameters and their possible values are presented as tables. Here's how to read them:

Standard or Default parameter

The following parameters are mandatory for each request. They identify you as a merchant and ensure that only authorized API requests are processed by our platform. You can find the parameters in our PMI:

Personal parameter

Additionally, some information about the customer can be transmitted. For details about the individual parameters and more parameters that are available but not listed here, please refer to the Server API Description.

Order Details

We need also information about the order and the choosen payment method.

clearingtype=rec
    reference=1234567890 (your unique reference)
    amount=10000
    currency=EUR
    request=preauthorization

For details about the individual parameters and more parameters that are available but not listed here, please refer to the Server API Description.

Where to go from here

This intro is just the tip of the iceberg. For online bank transfer like Sofort.com, you'll need to redirect the customer to an URL specified in the response. For credit card processing, you'll need to setup a HTML container for input fields made available through our invisible iFrame integration and make sure your system never comes in contact with genuine credit card data. PAYONE will provide you with a pseudo card number that you can use to preauthorize and capture transactions just like in the examples below:

Preauthorization

This set of parameters would tell PAYONE to create an order with the above mentioned personal data. For detailed information Server API - Preauthorization

Capture

Once the shipment is ready, the order can be captured. Capturing indicates that the order should be finalized in terms of bookkeeping and, if applicable, that the money can be transferred (i.e. for credit card payments or direct debit, see below):

The sequencenumber parameter ensures that all transaction status notifications have been processed before new requests can be sent to our API. It is incremented with each pair of request and transaction status notification. For the preauthorization request it is always implied as 0 and must not be sent. For detailed information Server API - Capture

Overview over our Server API Requests