Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Code Block
languagebash
titleSampe Request
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


UI Text Box
typeinfo

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

Code Block
titleSample Response
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:

ParameterRequiredShort 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

Payoneparameter
FormatCHAR
Length1..255
Permitted[a-z][0-9],.-


any string with a length of one to 255 characters and conditionally allowed characters as regex

Payoneparameter
FormatNUMERIC
Length1..10


Only numbers allowed

Payoneparameter
FormatLIST


choose from a list of permitted values


Standard parameter

The following parameters are mandatory for each request:

Standard parameter

Parameter

Required

Short explanation

mid

+

Excerpt Include
mid - definition
mid - definition
nopaneltrue

portalid

+

Excerpt Include
portalid - definition
portalid - definition
nopaneltrue

key

+

Excerpt Include
key - definition
key - definition
nopaneltrue

api_version

+

Excerpt Include
api_version - definition
api_version - definition
nopaneltrue

mode

+

Excerpt Include
mode - definition
mode - definition
nopaneltrue

request

+

Excerpt Include
request - definition
request - definition
nopaneltrue

encoding

-

Excerpt Include
encoding - definition
encoding - definition
nopaneltrue


Table of Contents
outlinetrue
indent2em
absoluteUrltrue