Page tree
Skip to end of metadata
Go to start of metadata

Data transfer

The content type must be set to "application/x-www-form-urlencoded"

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

The return of the data is based on 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
...

 

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:

Standard parameter

Parameter

Required

Short explanation

mid

+

Merchant ID, defined by PAYONE

Format

NUMERIC(5..6)

portalid

+

Portal ID, defined by PAYONE

Format

NUMERIC(7)

key

+

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

CHAR(1..32) lowercase
Permitted Symbols
[0-9,a-z]

api_version

+

New parameter api_version should be added to current implementations as it will be mandatory in future.

Format

LIST 
api_versionCommentDescription

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”

mode

+

Mode for transactions, either ‘live’ or ‘test’

Format

LIST 

valueComment

live

Transaction should be performed in live mode.

test

Transaction should be simulated

request

+

The type of request you would like to perform

Format

LIST 

Link to Request-Overview: Request Overview

encoding

-

The type of character encoding used in the request.

Format

LIST 

valueComment

ISO-8859-1

Default if not specified

UTF-8


  • No labels