Data transfer

Sending 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).

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

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

Our sample request throughout the docs favor readability over technical accuracy, so we'll show the sample requests as multiple lines, even though the content is technically x-www-form-urlencoded.

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 ("=").

Receiving Data Example
POST https://api.pay1.de/post-gateway/
User-Agent: "xxx x.x"
Content-Type: "application/x-www-form-urlencoded; charset=UTF-8"

encoding=UTF-8&
parameter1=value1&
parameter2=value2&
...

API Endpoint

The requests must be sent to the following URL:

API URL:  https://api.pay1.de/post-gateway/

Standard parameter

The following parameters are mandatory for each request:

Account Parameters
request
required
Format LIST
Request types
Preauthorization
Authorization
Capture
Debit
Refund
...
mid
required
Format NUMERIC(5..6)

Merchant ID, defined by PAYONE
aid
required
your subaccount ID, 5-digit numeric
portalId
required
Format NUMERIC(7)

Portal ID, defined by PAYONE
mode
required
Format LIST
Value Comment
live Transaction should be performed in live mode.
test Transaction should be simulated

Mode for transactions, either ‘live’ or ‘test’
encoding
optional
Format LIST
Value Comment
ISO-8859-1 Default if not specified
UTF-8

The type of character encoding used in the request.
api_version
required
Format LIST
api_version Comment Description
3.8 Current API-version
(Default if not present)
3.9 New API-version
from 2015-01-05		 New response “pending” added for “preauthorization” / “authorization”
3.10 New API-version
from 2016-06-01		 Response for “customermessage” can be more specific in case of error by containing detailed error messages from external payment gateways (e.g. Ratepay, …)
3.11 New API-version
from 2018-02-01

Request “capture” with response “pending”

Announcement for upcoming request “refund” / response “pending”
Announcement for upcoming request “createaccess” / response “pending”

New parameter api_version should be added to current implementations as it will be mandatory in future.
key
required
Format CHAR(1..32) lowercase
Permitted Symbols [0-9,a-z]

Payment portal key as MD5 value. The key is used to check the authentification of the sender (either your system for sending requests or PAYONE platform for sending notifications).

 
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded