- Created by PAYONE Admin, last modified on 2021-11-30
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).
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¤cy=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 ("=").
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/
How to Read Our Parameter Tables
Parameters and their possible values are presented as tables. Here's how to read them:
Parameter | Required | Short Explanation |
---|---|---|
the parameter name as you need to send it | + - always required - - always optional o - conditionally required (see explanation for conditions) | a short explanation of what the parameter does plus format definitions Formats can be
Format any string with a length of one to 255 characters and conditionally allowed characters as regex
Format
Format |
Standard parameter
The following parameters are mandatory for each request:
Standard parameter | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter | Required | Short explanation | |||||||||||||||
+ | Merchant ID, defined by PAYONE Format NUMERIC(5..6) | ||||||||||||||||
+ | Portal ID, defined by PAYONE Format | ||||||||||||||||
+ | 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). Format | ||||||||||||||||
+ | New parameter api_version should be added to current implementations as it will be mandatory in future. Format 3.8 Current API-version 3.9 New API-version 3.10 New API-version 3.11 New API-version Request “capture” with response “pending” | ||||||||||||||||
+ | Mode for transactions, either ‘live’ or ‘test’ Format live Transaction should be performed in live mode. test Transaction should be simulated | ||||||||||||||||
+ | Format Link to Request-Overview: Request Overview | ||||||||||||||||
- | The type of character encoding used in the request. Format ISO-8859-1 UTF-8 |
- No labels