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

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.

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 del ivery

Data is stored
Payment process is initialised

Financing

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

Request "preauthorization"

Common Parameter

RequiredFormatComment

aid

+


Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)



Format

LIST 
valueCommentDescription / Comments
elvDebit payment

According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19.

Please use request “updateuser” to update customers address data.

This means that the whole address for bank transfers needs to be provided.

ccCredit card
recInvoice
codCash on deliverynot allowed for vauthorization, createaccess, updateaccess
vorPrepaymentnot allowed for vauthorization, createaccess, updateaccess
sbOnline Bank Transfernot allowed for vauthorization, createaccess, updateaccess
wlte-walletnot allowed for vauthorization, createaccess, updateaccess
fncFinancingnot allowed for vauthorization, createaccess, updateaccess
cshCash or Hybrid Paymentsnot allowed for vauthorization, createaccess, updateaccess

reference

+


Merchant reference number for the payment process (case insensitive)

Format

CHAR(1..20)
Permitted Symbols
[0-9][a-z][A-Z], .,-,_,/

amount

+


Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona.

The amount must be less than or equal to the amount of the corresponding booking.

Format

NUMERIC(1..10)


Permitted values

max. +/- 19 999 999 99

currency

+


Specifies currency for this transaction


Format

LIST 

Permitted values

 ISO 4217 (currencies) 3-letter-codes

Samples

EUR
USD
GBP

param

-


Individual parameter (per payment process)

Format

CHAR(1..255)

narrative_text

-


Dynamic text element on account statements

Format

CHAR(1..81)

(3 lines with 27 characters each) and credit card statements.

customer_is_present

-


Indicates whether customer is “present” and can enter his/her data in the shop (=yes). Or customer is not present and can not enter any data (=no).

Format

LIST 

Permitted Values

yes
no

recurrence

-


Indicates recurring payments. Currently only supported for PayPal.

Format

LIST 

valueComments

none

No

oneclick

One-click-checkout

recurring

Recurring payments

installment

Installment payments

Parameter ( PAYONE Secure Invoice )

clearingsubtype

+


Only valid with “clearingtype=rec”. Used for PAYONE Secure Invoice.

Format

LIST 

Parameter ( personal data )

customerid

-


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

Format

CHAR(1..20)
Permitted Symbols
[0-9, a-z, A-Z, .,-,_,/]
  • "customerid" can be used to identify a customer record.
  • If "customerid" is used then stored customer data are loaded automatically.

userid

-


PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

businessrelation

o


Value specifies business relation between merchant and customer

Format

LIST 
valueComment

b2c

Indicates business to private customer

b2b

indicates business to business customer (company)

salutation

-


The customer's salutation

Format

CHAR(1..10)

title

-


Title (e.g. "Dr", "Prof.") of customer

Format

CHAR(1..20)

firstname

o


First name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(1..50)

Payment specific:

Payment/request typeComments
PNTCombination of firstname + lastname is limited to 27 characters
BCTfirstname / lastname are always mandatory
KLV, KLSfirstname / lastname are always mandatory
PYV, PYM, PYS, PYDfirstname / lastname are always mandatory
PDTfirstname / lastname are always mandatory
PSCfirstname / lastname are always mandatory
addresscheckfirstname / lastname are always mandatory
consumerscorefirstname / lastname are always mandatory

lastname

+


Last name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(2..50)

company

-


Company name of customer; The company name is optional if lastname is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(2..50)

street

-



Street number and name

Format

CHAR(1..50)

addressaddition

-


Specifies an additional address line for the invoice address of the customer.

Format

CHAR(1..50)

Samples

7th floor
c/o Maier

zip

-


Postcode

Format

CHAR(2..10)
Permitted Symbols
[0-9][A-Z][a-z][_.-/ ]

city

-


City of customer

Format

CHAR(2..50)

country

+


Specifies country of address for the customer

Format

LIST 

Permitted values

ISO 3166 2-letter-codes

Samples

DE
GB
US

Some countries require additional information in parameter "state"

state

-


Specifies state / region of country for the customer.
"state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN

Format

LIST

Permitted values


Samples US

AK
AL
AR

Samples CA

AB
BC

email

-


email-address of customer

Format

CHAR(5..254)
Permitted Symbols
RFC 5322

telephonenumber

-


Phone number of customer

Format

CHAR(1..30)

birthday

-


Date of birth of customer


Format

DATE(8), YYYYMMDD

Samples

20190101
19991231

language

-


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.

Format

LIST 

Permitted values

ISO 639-1 (Language) 2-letter-codes

vatid

-


VAT identification number. Used for b2b transactions to indicate VAT number of customer.

Format

CHAR(1..50)

gender

-


Gender of customer (female / male / divers* )

Format

LIST 

Permitted values

f    
m
d

* not in use by now

personalid

-


Person specific numbers or characters, e.g. number of passport / ID card

Format

CHAR(1..32)
Permitted Symbols
[0-9][A-Z][a-z][+-./()]

ip

-


Customer's IP-V4-address (123.123.123.123) or IP-V6-address

Format

CHAR(1..39)

Parameter ( delivery data )

shipping_firstname

-


First name of delivery address

Format

CHAR(1..50)

shipping_lastname

-


Surname of delivery address

Format

CHAR(1..50)

shipping_company

-


Company Name of the delivery address

Format

CHAR(2..50)

shipping_street

-


Street number and name of delivery address

Format

CHAR(2..50)

shipping_zip

-


Postcode of delivery address

Format

CHAR(2..10)
Permitted Symbols
[0-9][A-Z][a-z][_.-/]

shipping_addressaddition

-


Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier".

Format

CHAR(1..50)

shipping_city

-


City of delivery address

Format

CHAR(2..50)

shipping_state

o


Specifies state of country of delivery address for the customer
"shipping_state" is required, if shipping_country is geiven, for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN

Format

LIST

Permitted values


Samples US

AK
AL
AR

Samples CA

AB
BC

shipping_country

-


Specifies country of delivery address for the customer

Format

LIST 

Permitted values

ISO 3166 2-letter-codes

Samples

DE
GB
US

Some countries require additional information in parameter shipping_state

Parameter ( debit payment )

iban

o


IBAN to be used for payment or to be checked

Format

CHAR(10..34)
Permitted Symbols
[0-9][A-Z]

bic

o


Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11)
Permitted Symbols
[0-9][A-Z]

bankcountry

o


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

Format

LIST 

bankaccount

o


Account number (BBAN)

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

Format

NUMERIC(1..10)

bankcode

o


Sort code (BBAN) (only in DE)

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

Format

NUMERIC(8)

bankaccountholder

o


Account holder


Format

CHAR(1..50)

mandate_identification

o


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.

Format

CHAR(1..35)
Permitted Symbols
[A-Z,a-z,0-9,+,-,.,(,)]

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

Parameter ( online transfer )

onlinebanktransfertype

+


Format

LIST 

Value

Comment

Server-APIClient-API

Frontend

BCTBancontact(tick)(tick)(minus)
EPSeps – online transfer (AT)(tick)(tick)(tick)
GPYgiropay (DE)(tick)(tick)(tick)
IDLiDEAL (NL)(tick)(tick)(tick)
MBCMultibanco(tick)(tick)(minus)
MYBMyBank(tick)(tick)(minus)
P24Przelewy24 (PL)(tick)(tick)(tick)
PFFPostFinance E-Finance (CH)(tick)(tick)(tick)
PFCPostFinance Card (CH)(tick)(tick)(tick)
PNTSOFORT Überweisung(tick)(tick)(tick)
TRLTrustly(tick)(tick)(minus)
VKPVerkkopankki(tick)(tick)(minus)

bankcountry

+

Default

Account type/ country (DE, AT, CH, NL, PL)

iban

o


Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11)
Permitted Symbols
[0-9][A-Z]

bic

o


Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11)
Permitted Symbols
[0-9][A-Z]

bankaccount

o


Account number (BBAN)

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

Format

NUMERIC(1..10)

bankcode

o


Sort code (BBAN) (only in DE)

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

Format

NUMERIC(8)

bankgrouptype

o


Issuer of Online-Bank-Transfer used for iDEAL and EPS

Format

LIST 

successurl

+


URL for "payment successful"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

errorurl

+


URL for "faulty payment"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

backurl

+


URL for "Back" or "Cancel"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

Parameter ( e-wallet )

wallettype

+


Used with "clearingtype=wlt" to identify wallet payment types

successurl

+


URL for "payment successful"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

errorurl

+


URL for "faulty payment"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

backurl

+


URL for "Back" or "Cancel"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

it[n]

o


Parameter it[n] specifies the item type of a shopping cart item.

Format

LIST 

Array

Array elements [n] starting with [1]; serially numbered; max [400]


it[n]

Comments


goodsGoods
shipment

Shipping charges


handling

Handling fee

  • Not to be used with PDT
voucherVoucher / discount
  • Not to be used with PDT

id[n]

o


Product number, order number, etc. of this item

Format

CHAR(1..34)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]

pr[n]

o


Unit gross price of the item in smallest unit! e.g. cent

Format

NUMERIC(10) max. 19 999 999 99

Array

Array elements [n] starting with [1]; serially numbered; max [400]

no[n]

Quantity of this item

Format

NUMERIC(6)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

de[n]

o


Description of this item. Will be printed on documents to customer.

Format

CHAR(1..255)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Example
de[1]=Product 1
de[2]=Product 2
de[3]=Product 3
...
de[400]=Product 400

va[n]

o


VAT rate (% or bp)

Format

NUMERIC(4)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Parameter ( cash on delivery )

shippingprovider

+


Shipping Provider

Format

LIST 
Shipping ProviderComment
DHL

DHL, Germany

Parameter ( credit card )

cardpan

+


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

+


Card type of credit card

Format

LIST 
valueCommentBIN-Range for automatic card type detection

V

Visa

4

M

MasterCard

51-55,2221-2720

A

American Express

34, 37
DDiners / Discover

300-305,3095,36,38,39

601, 64, 65

CDiscover

J

JCB

3528-3589

O

Maestro International

50, 56-58,602, 61, 620, 627, 63, 67
PChina Union Pay62212600-62299800,624-626, 6282-6288
UUATP / Airplus1220, 1920 -> coming soon; not available yet

cardexpiredate

+


Credit card expiry date YYMM


Format

NUMERIC(4), YYMM

cardcvc2

o


Credit card security number

Format

NUMERIC(3..4)

For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used.

cardissuenumber

-



cardholder

-


Cardholder of credit card.


Format

CHAR(1..50)

ecommercemode-

Specifies how the payment transaction should be processed - if not default.

Format

LIST 

valueComments

internet

eCommerce Transaction (SSL secured)

3dsecure

3-D Secure transaction (can be enabled alternatively in the risk settings)

moto

Mail or telephone order transaction

Parameter ( credit card with pseudo card number )

pseudocardpan

+


Pseudo primary account number for a credit card.

Format

NUMERIC(16..19)

Parameter ( 3-D Secure )

xid

o


  • 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.:

Format

CHAR(1..60)

cavv

-


3-D Secure authentication value

Format

CHAR(1..40)

eci

-


3-D Secure e-commerce indicator

Format

CHAR(1..2)

successurl

+


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

URL for "payment successful"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

errorurl

+


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

URL for "faulty payment"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

backurl

+


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

URL for "Back" or "Cancel"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>
<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

Parameter ( Financing )

financingtype

+


Used with "clearingtype=fnc" to identify Financing type

Format

LIST 

ValueCommentServer-APIClient-APIFrontend

RPV

Ratepay Invoicing

(tick)(tick)(tick)

RPS

Ratepay Installment

(tick)(tick)

RPP

Ratepay Prepayment

(tick)(tick)(tick)

RPD

Ratepay Debit

(tick)(tick)(tick)

PYV

Paysafe Pay Later-Invoicing

(tick)(tick)

PYS

Paysafe Pay Later-Installment

(tick)(tick)

PYM

Paysafe Pay Later-Monthly

(tick)(tick)

PYD

Paysafe Pay Later-Debit

(tick)(tick)
PPIPayPal Installment(tick)(tick)

KLV

Klarna Invoice

(tick)(tick)

KLS

Klarna Installment

(tick)(tick)

workorderid

o


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.

Format

CHAR(1..50)

it[n]

+


Parameter it[n] specifies the item type of a shopping cart item.

Format

LIST 

Array

Array elements [n] starting with [1]; serially numbered; max [400]


it[n]

Comments


goodsGoods
shipment

Shipping charges


handling

Handling fee

  • Not to be used with PDT
voucherVoucher / discount
  • Not to be used with PDT

id[n]

+


Product number, order number, etc. of this item

Format

CHAR(1..34)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]

pr[n]

+


Unit gross price of the item in smallest unit! e.g. cent

Format

NUMERIC(10) max. 19 999 999 99

Array

Array elements [n] starting with [1]; serially numbered; max [400]

no[n]

+


Quantity of this item

Format

NUMERIC(6)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

de[n]

+


Description of this item. Will be printed on documents to customer.

Format

CHAR(1..255)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Example
de[1]=Product 1
de[2]=Product 2
de[3]=Product 3
...
de[400]=Product 400

va[n]

-


VAT rate (% or bp)

Format

NUMERIC(4)

Array

Array elements [n] starting with [1]; serially numbered; max [400]


Response "preauthorization"

Common Parameter

RequiredFormatComment

status

+


APPROVED / REDIRECT / ERROR / PENDING

Parameter (APPROVED)

txid

+


The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

userid

+


PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

Parameter (PENDING)(currently only supported for KLV/KLS)

txid

+


The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

userid

+


PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

Parameter (REDIRECT) (3-D Secure/online transfer/e-wallet)

txid

+


The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

userid

+


PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

redirecturl

+


Redirect URL → zMerchant system has to redirect customer to this URL to complete payment

Format

CHAR(2..2000)

Parameter (ERROR)

errorcode

+


In case of error the PAYONE Platform returns an error code for your internal usage.

Format

NUMERIC(1..6)

errormessage

+


In case of error the PAYONE Platform returns an error message for your internal usage.

Format

CHAR(1..1024)

customermessage

-


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

Format

CHAR(1..1024)

Parameter ( credit card – if AVS has been ordered )

protect_result_avs

-

A1

AVS return value, see AVS-Returns (protect_result_avs)

Parameter ( Prepayment/cash on delivery )

clearing_bankaccountholder

+

AN..35

Recipient bank account holder

clearing_bankcountry

+

Default

Recipient account type/ country

(e.g. DE, AT, etc.)

clearing_bankaccount

+

AN..26

Recipient account number

clearing_bankcode

o

AN..11

Recipient sort code

clearing_bankiban

-

AN..35

Recipient IBAN

clearing_bankbic

-

AN..11

Recipient BIC

clearing_bankcity

-

AN..50

Recipient city or bank

clearing_bankname

-

AN..50

Recipient bank name

Parameter ( direct debit )

mandate_identification

-

AN..35

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.

Format

CHAR(1..35)
Permitted Symbols
[A-Z,a-z,0-9,+,-,.,(,)]

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

mandate_dateofsignature

-

N..10

date when mandate has been created

(format YYYYMMDD)

creditor_identifier

-

AN..35

used CID for debit payment

creditor_name

-

AN..35

as recorded in PAYONE Platform

creditor_street

-

AN..35

as recorded in PAYONE Platform

creditor_zip

-

AN..10

as recorded in PAYONE Platform

creditor_city

-

AN..50

as recorded in PAYONE Platform

creditor_country

-

Default

Country (ISO 3166)

creditor_email

-

AN..254

as recorded in PAYONE Platform


Content


  • No labels