Versions Compared

Key

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

General

Data transfer

The data transfer is processed directly via an HTTPS-POST or HTTPS-GET request by the browser of the customer.

The data is returned in JSON data format or as parameter in an HTTP redirect.

Endpoint URL

The requests must be sent to the following URL:

Client API URL:  https://secure.pay1.de/client-api/

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

With each request the following parameters must always be submitted.

Standard parameter

Parameter

Required

Format

Comment

mid

+

N..6

Excerpt Include
mid - definition
mid - definition
nopaneltrue

portalid

+

N..7

Excerpt Include
portalid - definition
portalid - definition
nopaneltrue

api_version

+

Default

Excerpt Include
api_version - definition
api_version - definition
nopaneltrue

mode

+

Default

Excerpt Include
mode - definition
mode - definition
nopaneltrue

request

+

Default

Queries:

- creditcardcheck

- bankaccountcheck

Excerpt Include
request - definition
request - definition
nopaneltrue

responsetype

+

Default

- JSON

- REDIRECT

hash

+

AN..32
AN..96

MD5 hash code (see CA - Calculation of the HASH value)
SHA2-384 hash code (see CA - Calculation of the HASH value)

Excerpt Include
hash - definition
hash - definition
nopaneltrue

successurl

o

AN..255

URL "payment successful"

(only if responsetype=REDIRECT or required by corresponding request)

Excerpt Include
successurl - definition
successurl - definition
nopaneltrue

errorurl

o

AN..255

URL "faulty payment"

(only if responsetype=REDIRECT or required by corresponding request)

Excerpt Include
errorurl - definition
errorurl - definition
nopaneltrue

encoding

-

Default

Excerpt Include
encoding - definition
encoding - definition
nopaneltrue



Table of Contents
outlinetrue
indent2em
absoluteUrltrue