Table Of Contents
  INTRODUCTION  SEQUENCE DIAGRAMS

Introduction

With the preauthorization request the transmitted amount is reserved. According to the type of payment, specific functions are carried out.

This option is only available in the "Shop" option.

Overview

Initialing a payment reservation with the different payment types causes the following actions:

Credit card

Credit card data is verified and stored.
The amount is reserved on the customer's card

Debit payment

Account data is verified and stored.

Online Bank Transfer

Account data is verified
Online transfer session is initialised
Amount will be charged to the account directly after payment is completed

e-wallet

E-wallet session is initialised
Amount is reserved after the payment has been completed

Prepayment

Data is stored
Payment process is initialised

Invoice

Data is stored
Payment process is initialised

Cash on delivery

Data is stored
Payment process is initialised

Financing

Payment type Klarna require item data, billing and delivery address need to be identical.

 
POST Request - Preauthorization
Account Parameters
request
required
Fixed Value: preauthorization
mid
required
your merchant ID, 5-digit numeric
aid
required
your subaccount ID, 5-digit numeric
portalId
required
your Portal ID, 7-digit numeric
key
required
your key value, alpha-numeric
common Parameters
clearingtype
required
Fixed Value wtl/fnc/sb/cc/vor/rec
clearingsubtype
optional
Fixed Value POV

Only valid with “clearingtype=rec”. Used for PAYONE Secure Invoice.
mode
required
Fixed Value test/live

Can be either test environment (test) or live environment (live)
reference
required
Format CHAR(2..255)

A unique ID that will be displayed in your shop backend and for the customer
amount
optional
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro.

The amount must be less than or equal to the amount of the corresponding booking.
currency
optional
Format LIST
Permitted values ISO 4217 (currencies) 3-letter-codes
Samples
EUR
USD
GBP
param
optional
Format CHAR(1..255)

Individual parameter (per payment process)
narrative_text
optional
Format CHAR(1..81)

Dynamic text element on account statements (3 lines with 27 characters each) and credit card statements.
customer_is_present
optional
Format LIST
Permitted Values

yes

no

Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no).
recurrence
optional
   
Format LIST
Value Comment
none a non recurring payment, i.e. a single authorization which might be captures at once or later in one or multiple charges
oneclick a form of payment on which the cardholder is authenticated only on the initial transaction. Follow-up transactions are authorized without active interaction of the cardholder
recurring a recurring payment, which has an a priori defined frequency and limit/threshold
installment a recurring payment, which has an a priori defined frequency, limit/threshold and end date

Indicates recurring payments. Currently only supported for PayPal and Credit Card.
PERSONAL DATA Parameters
customerid
optional
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/]

Merchant's customer ID, defined by you / merchant to refer to the customer record.

"customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically.
userid
optional
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE
salutation
optional
Format CHAR(1..10)

The customer's salutation
title
optional
Format CHAR(1..20)
Samples

Dr

Prof.

Dr.-Ing.

Title of the customer
firstname
optional
Format CHAR(1..50)

First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname"
lastname
optional
Format CHAR(2..50)

Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname"
businessrelation
optional
Format LIST
Value Comment
b2c

Indicates business to private customer
b2b

indicates business to business customer (company)

Value specifies business relation between merchant and customer
company
optional
Format CHAR(2..50)

Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname"
street
optional
Format CHAR(1..50)

Street number and name (required: at least one character)
addressaddition
optional
Format CHAR(1..50)
Samples

7th floor

c/o Maier

Specifies an additional address line for the invoice address of the customer.
zip
optional
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]

Postcode
city
optional
Format CHAR(2..50)

City of customer
country
optional
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples

DE

GB

US

Specifies country of address for the customer.
Some countries require additional information in parameter "state".
state
required (in CN)
Format LIST
Permitted values: ISO 3166-2 States (regions) 2-letter-codes
Samples US Samples CA
AK AB
AL BC

Specifies state / region of country for the customer.
"state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN and must not be used for all other countries.
email
optional
Format CHAR(5..254)
Permitted Symbols RFC 5322

Special Remark email validation:

Max. length for email is 254 characters. Validation is set up in the following way:

Username = Max. 63 characters

Domain Name = Max. 63 characters
Domain Suffixes = Max. 4 suffixes with max. 124 characters 
Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4]

"@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters.

email-address of customer
telephonenumber
optional
Format CHAR(1..30)

Phone number of customer
birthday
optional
Format DATE(8), YYYYMMDD
Samples

20190101

19991231

Date of birth of customer
language
optional
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes

Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display).

If the language is not transferred, the browser language will be used. For a non-supported language English will be used.
vatid
optional
Format CHAR(1..50)

VAT identification number. Used for b2b transactions to indicate VAT number of customer.
gender
optional
Format LIST
Permitted values: f / m / d*

Gender of customer (female / male / diverse* )

* currently not in use
personalid
optional
Format CHAR(1..32)
Permitted Symbols [0-9][A-Z][a-z][+-./()]

Person specific numbers or characters, e.g. number of passport / ID card
ip
optional
Format CHAR(1..39)

Customer's IP-V4-address (123.123.123.123) or IP-V6-address
Delivery data Parameters
shipping_firstname
optional
Format CHAR(1..50)

First name of delivery address
shipping_lastname
optional
Format CHAR(1..50)

Surname of delivery address
shipping_company
optional
Format CHAR(2..50)

Company name of delivery address
shipping_street
optional
Format CHAR(2..50)

Street number and name of delivery address
shipping_zip
optional
Format CHAR(2..50)

Postcode of delivery address
shipping_city
optional
Format CHAR(2..50)

City of delivery address
shipping_addressaddition
optional
Format CHAR(1..50)

Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier".
shipping_country
optional
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples

DE

GB

US

Specifies country of address for the customer.

Some countries require additional information in parameter "state"
shipping_state
required (in CN)
Format LIST
Permitted values ISO 3166-2 States (regions)  2-letter-codes
Samples US Samples CA
AK AB
AL BC
URL PARAMETERS
successurl
optional
Format CHAR(2..255)
Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

URL for "payment successful"
errorurl
optional
Format CHAR(2..255)
Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

URL for "faulty payment"
backurl
optional
Format CHAR(2..255)
Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

URL for "Back" or "Cancel"
Article Parameters
it[n]
optional
it[n] Comments
goods Goods
shipment Shipping Charges
handling Handling fee
voucher Voucher / discount

required for physical goods in order to ensure PayPal seller protection
id[n]
optional
Format CHAR(1..32)
Array elements [n] starting with [1]; serially numbered; max [400]
Permitted Symbols [0-9][a-z][A-Z], .,-,_,/

International Article Number (EAN bzw. GTIN)

Product number, SKU, etc. of this item.
pr[n]
optional
Format NUMERIC(10) max. 19 999 999 99
Array elements [n] starting with [1]; serially numbered; max [400]

Unit gross price of the item in smallest unit! e.g. cent.
no[n]
optional
Format NUMERIC(6)
Array elements [n] starting with [1]; serially numbered; max [400]

Quantity of this item.
de[n]
optional
Format CHAR(1..255)
Array elements [n] starting with [1]; serially numbered; max [400]

Required for physical goods in order to ensure PayPal seller protection

Description of this item. Will be printed on documents to customer.
va[n]
optional
Format NUMERIC(4)

VAT rate (% or bp)

Array elements [n] starting with [1]; serially numbered; max [400]
online TRANSFER PARAMETERS
onlinebanktransfertype
optional
Format LIST
BCT Bancontact
EPS eps – online transfer (AT)
IDL iDEAL (NL)
MBC Multibanco
MYB MyBank
P24 Przelewy24 (PL)
PFF PostFinance E-Finance (CH)
PFC PostFinance Card (CH)
PNT SOFORT Überweisung
TRL Trustly
VKP Verkkopankki
bankgrouptype
optional
Format LIST
List of supported EPS banks Bank Groups (EPS) (bankgrouptype)
List of supported iDEAL banks Bank Groups (iDEAL) (bankgrouptype)

Issuer of Online-Bank-Transfer used for iDEAL and EPS
 
bankcountry
optional
Format LIST
Permitted Values DE; DK; EE; ES; FI; IT; MT; NL; NO; PL; SE

Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE

DE: Mandatory with bankcode, bankaccount, optional with IBAN

For other countries than DE please use IBAN or IBAN/BIC
iban
optional
Format CHAR(8 or 11) Only capital letters and digits, no spaces
Permitted Symbols [0-9][A-Z]

Bank Identifier Code to be used for payment or to be checked
bic
optional
Format CHAR(8 or 11) Only capital letters and digits, no spaces
Permitted Symbols [0-9][A-Z]

BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required.
bankaccount
optional
Format NUMERIC(1..10)

DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
Not DE: Please use IBAN or IBAN / BIC.
bankcode
optional
Format NUMERIC(8)

DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
Not DE: Please use IBAN or IBAN / BIC.
bankaccountholder
optional
Format CHAR(1..50)

Account holder
mandate_identification
optional
Format CHAR(1..35)
Permitted Symbols [A-Z,a-z,0-9,+,-,.,(,)]

A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique.

If the mandate_identification is not set PAYONE will create an unique mandate identification (pattern: PO-nnnnnnnnnn).

PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification
Wallet Parameter
wallettype
optional
Format LIST 
ALP Alipay
AMZ Amazon Payments
PDT Giropay
PPE PayPal
PSC paysafecard
APL Apple Pay

Used with "clearingtype=wlt" to identify wallet payment types
Cash on Delivery PARAMETER
shippingprovider
optional
Format LIST
Fixed Value DHL

Only mandatory for cash on delivery
Credit Card Parameters
cardpan
optional
Primary account number of credit card
Format NUMERIC(13..19)
If your system handles "cardpan" directly you can not be PCI DSS SAQ A compliant.
For simple PCI DSS SAQ A compliance please use PAYONE hosted iFrames together with pseudocardpan.
cardtype
optional
Format LIST

Card type of credit card

Primary account number of credit card

Value Comment BIN-Range for automatic card type detection
V Visa 4
M MasterCard 51-55,2221-2720
A American Express 34, 37
D Diners / Discover

300-305,3095,36,38,39

601, 64, 65
J JCB 3528-3589
O Maestro International 50, 56-58,602, 61, 620, 627, 63, 67
P China Union Pay 62212600-62299800,624-626, 6282-6288
U UATP / Airplus 1220, 1920 -> coming soon; not available yet
G girocard 68*

*girocard is currently only viable for e-commerce-payments via Apple Pay.
cardexpiredate
optional
Format NUMERIC(4), YYMM

Credit card expiry date YYMM
cardcvc2
optional
 Format NUMERIC(3..4)
For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used.
cardissuenumber
optional
Format NUMERIC(1..2)

Card issue number (only Maestro UK cards)
cardholder
optional
Format CHAR(1..50)

Cardholder of credit card.
ecommercemode
optional
Format LIST
Value Comments
internet eCommerce Transaction (SSL secured)
3dsecure 3-D Secure transaction (can be enabled alternatively in the risk settings)
moto Mail or telephone order transaction

Specifies how the payment transaction should be processed - if not default.
pseudocardpan
optional
Format NUMERIC(16..19)

Pseudo primary account number for a credit card.
3-D Secure Parameters
xid
optional
Format CHAR(1..60)
  • either "xid" (from previous 3dscheck)
  • or "successurl", "errorurl", "backurl" must be given.

3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.:

  • value for "xid" is returned by request 3dscheck (optional request)
  • and then has to be used for request authorization, preauthorization or createaccess in request data
cavv
optional
Format CHAR(1..40)

3-D Secure authentication value
eci
optional
Format CHAR(1..2)

3-D Secure e-commerce indicator
successurl
optional
Format CHAR(2..255)
Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

- either "xid" (from previous 3dscheck)
- or "successurl", "errorurl", "backurl" must be given
- or default "successurl" and "backurl" for a portal are configured within PMI.
 

URL for "payment successful"
errorurl
optional
Format CHAR(2..255)
Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

- either "xid" (from previous 3dscheck)
- or "successurl", "errorurl", "backurl" must be given.
 

URL for "faulty payment"
backurl
optional
Format CHAR(2..255)
Scheme <scheme>://<host>/<path>
       <scheme>://<host>/<path>?<query>
       
scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

- either "xid" (from previous 3dscheck)
- or "successurl", "errorurl", "backurl" must be given
- or default "successurl" and "backurl" for a portal are configured within PMI.
 

URL for "Back" or "Cancel"
Financing Parameters
financingtype
optional
Format LIST

Used with "clearingtype=fnc" to identify Financing type

Value Comment
RPV Ratepay Open Invoice
RPS Ratepay Installments
RPP Ratepay Prepayment
RPD Ratepay Direct Debit
PYV Unzer Invoice
PYS Unzer Installment
PYM Unzer Monthly
PYD Unzer Direct Debit
PPI PayPal Installment
KLV Klarna Checkout Invoice
KLS Klarna Checkout Installment
KIS Klarna Payments "Slice it" (Installments)
KIV Klarna Payments "Pay now" (Invoice)
KDD Klarna Payments "Pay now" (Direct Debit)
KBT Klarna Payments "Pay now" (Bank Transfer)
PIV PAYONE Secured Invoice
PDD PAYONE Secured Direct Debit
PIN PAYONE Secured Installment
workorderid
optional
Format CHAR(1..50)

The workorderid is a technical id returned from the PAYONE platform to identify a workorder. A workorder is a part of a payment process (identified by a txid). The workorderid is used for the genericpayment request.
Response Parameters
Permitted Values
APPROVED
PENDING
REDIRECT
ERROR
Response Parameter (approved)
txid
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE
Response Parameter (approved) - credit card – if AVS has been ordered
protect_result_avs
Format A1

AVS return value, see AVS-Returns (protect_result_avs)
Response Parameter (Approved) - Prepayment/cash on delivery
clearing_bankaccountholder
Format AN..35

Recipient bank account holder
 clearing_bankcountry

Recipient account type/ country (e.g. DE, AT, etc.)
 clearing_bankaccount
Format AN..26

Recipient account number
 clearing_bankcode
Format AN..11

Recipient sort code
 clearing_bankiban
Format AN..35

Recipient IBAN
 clearing_bankbic
Format AN..11

Recipient BIC
 clearing_bankcity
Format AN..50

Recipient city or bank
 clearing_bankname
Format AN..50

Recipient bank name
Response Parameter (Approved) - direct debit
mandate_identification
Format CHAR(1..35)
Permitted Symbols [A-Z,a-z,0-9,+,-,.,(,)]

A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique.

PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification

If the mandate_identification is not set PAYONE will create an unique mandate identification 
(pattern: PO-nnnnnnnnnn).
mandate_dateofsignature
Format N..10

Date when mandate has been created

(format YYYYMMDD)
creditor_identifier
Format AN..35

Used CID for debit payment
creditor_name
Format AN..35

As recorded in PAYONE Platform.
 creditor_street
Format AN..35

As recorded in PAYONE Platform.
creditor_zip
Format AN..10

As recorded in PAYONE Platform.
creditor_city
Format AN..50

As recorded in PAYONE Platform.
creditor_country
Country (ISO 3166)
creditor_email
Format AN..254

As recorded in PAYONE Platform.
Response Parameter (Pending) - currently only supported for KLV/KLS
txid
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE
Parameter (REDIRECT) (3-D Secure/online transfer/e-wallet)
txid
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform
Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE
redirecturl
Format CHAR(2..2000)

Redirect URL → zMerchant system has to redirect customer to this URL to complete payment
Response Parameter (Error)
Format NUMERIC(1..6)

In case of error the PAYONE Platform returns an error code for your internal usage.
Format CHAR(1..1024)

In case of error the PAYONE Platform returns an error message for your internal usage.
Format CHAR(1..1024)

The customermessage is returned to your system in order to be displayed to the customer.

(Language selection is based on the end customer's language, parameter "language")

 
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload     
          
aid=52078
amount=3499
cardholder=max testerei
city=Dresden
clearingtype=cc
country=DE
currency=EUR
customer_is_present=yes
de[1]=Hauptartikel mit Eigenschaften XL
de[2]=Hauptartikel mit Kennzeichnung 
de[3]=Standard Versand
email=test@payone.com
encoding=UTF-8
errorurl=https://yourdomain.dev/failure/appendSession/
firstname=Maximillian
gender=m
id[1]=SW10007.3
id[2]=SW10006
id[3]=ship9
ip=172.19.0.34
it[1]=goods
it[2]=goods
it[3]=shipment
key=17031f73e2c6f9755788bddfff04169b
language=de
lastname=Testerei
mid=14648
mode=test
no[1]=1
no[2]=1
no[3]=1
param=session-1|n2ikm4l9ifpds5p1efv6dede76|f8222c6f3c6999ce98f5198078522be4
portalid=2037267
pr[1]=1999
pr[2]=1500
pr[3]=0
pseudocardpan=9410010000167640853
recurrence=oneclick
reference=1234000243
request=preauthorization
salutation=Herr
shipping_city=Dresden
shipping_country=DE
shipping_firstname=Maximillian
shipping_lastname=Testerei
shipping_street=Wegeweg 25
shipping_zip=01099
street=Wegeweg 25
successurl=https://yourdomain.dev/success/swPaymentToken/WQXEBlwaY9jx9lZFQyxocKc5Cj86rsU3/appendSession/
telephonenumber=01752345678
va[1]=1900
va[2]=1900
va[3]=0
zip=01099            
RESPONSE
                          
status=APPROVED
txid=987654321 
userid=123456789

Sequence Diagrams

Redirect with preauthorization