Versions Compared

Key

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

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

+


Excerpt Include
aid - definition
aid - definition
nopaneltrue



Excerpt Include
clearingtype - definition
clearingtype - definition
nopaneltrue

reference

+


Excerpt Include
reference - definition
reference - definition
nopaneltrue

amount

+


Excerpt Include
amount - definition
amount - definition
nopaneltrue

currency

+


Excerpt Include
currency - definition
currency - definition
nopaneltrue

param

-


Excerpt Include
param - definition
param - definition
nopaneltrue

narrative_text

-


Excerpt Include
narrative_text - definition
narrative_text - definition
nopaneltrue

customer_is_present

-


Excerpt Include
customer_is_present - definition
customer_is_present - definition
nopaneltrue

recurrence

-


Excerpt Include
recurrence - definition
recurrence - definition
nopaneltrue

Parameter ( PAYONE Secure Invoice )

clearingsubtype

+


Excerpt Include
clearingsubtype - definition
clearingsubtype - definition
nopaneltrue

Parameter ( personal data )

customerid

-


Excerpt Include
customerid - definition
customerid - definition
nopaneltrue

userid

-


Excerpt Include
userid - definition
userid - definition
nopaneltrue

businessrelation

o


Excerpt Include
businessrelation - definition
businessrelation - definition
nopaneltrue

salutation

-


Excerpt Include
salutation - definition
salutation - definition
nopaneltrue

title

-


Excerpt Include
title - definition
title - definition
nopaneltrue

firstname

o


Excerpt Include
firstname - definition
firstname - definition
nopaneltrue

lastname

+


Excerpt Include
lastname - definition
lastname - definition
nopaneltrue

company

-


Excerpt Include
company - definition
company - definition
nopaneltrue

street

-



Excerpt Include
street - definition
street - definition
nopaneltrue

addressaddition

-


Excerpt Include
addressaddition - definition
addressaddition - definition
nopaneltrue

zip

-


Excerpt Include
zip - definition
zip - definition
nopaneltrue

city

-


Excerpt Include
city - definition
city - definition
nopaneltrue

country

+


Excerpt Include
country - definition
country - definition
nopaneltrue

state

-


Excerpt Include
state - definition
state - definition
nopaneltrue

email

-


Excerpt Include
email - definition
email - definition
nopaneltrue

telephonenumber

-


Excerpt Include
telephonenumber - definition
telephonenumber - definition
nopaneltrue

birthday

-


Excerpt Include
birthday - definition
birthday - definition
nopaneltrue

language

-


Excerpt Include
language - definition
language - definition
nopaneltrue

vatid

-


Excerpt Include
vatid - definition
vatid - definition
nopaneltrue

gender

-


Excerpt Include
gender - definition
gender - definition
nopaneltrue

personalid

-


Excerpt Include
personalid - definition
personalid - definition
nopaneltrue

ip

-


Excerpt Include
ip - definition
ip - definition
nopaneltrue

Parameter ( delivery data )

shipping_firstname

-


Excerpt Include
shipping_firstname - definition
shipping_firstname - definition
nopaneltrue

shipping_lastname

-


Excerpt Include
shipping_lastname - definition
shipping_lastname - definition
nopaneltrue

shipping_company

-


Excerpt Include
shipping_company - definition
shipping_company - definition
nopaneltrue

shipping_street

-


Excerpt Include
shipping_street - definition
shipping_street - definition
nopaneltrue

shipping_zip

-


Excerpt Include
shipping_zip - definition
shipping_zip - definition
nopaneltrue

shipping_addressaddition

-


Excerpt Include
shipping_addressaddition - definition
shipping_addressaddition - definition
nopaneltrue

shipping_city

-


Excerpt Include
shipping_city - definition
shipping_city - definition
nopaneltrue

shipping_state

o


Excerpt Include
shipping_state - definition
shipping_state - definition
nopaneltrue

shipping_country

-


Excerpt Include
shipping_country - definition
shipping_country - definition
nopaneltrue

Parameter ( debit payment )

iban

o


Excerpt Include
iban - definition
iban - definition
nopaneltrue

bic

o


Excerpt Include
bic - definition
bic - definition
nopaneltrue

bankcountry

o


Excerpt Include
bankcountry - definition
bankcountry - definition
nopaneltrue

bankaccount

o


Excerpt Include
bankaccount - definition
bankaccount - definition
nopaneltrue

bankcode

o


Excerpt Include
bankcode - definition
bankcode - definition
nopaneltrue

bankaccountholder

o


Excerpt Include
bankaccountholder - definition
bankaccountholder - definition
nopaneltrue

mandate_identification

o


Excerpt Include
mandate_identification - definition
mandate_identification - definition
nopaneltrue

Parameter ( online transfer )

onlinebanktransfertype

+


Excerpt Include
onlinebanktransfertype - definition
onlinebanktransfertype - definition
nopaneltrue

bankcountry

+

Default

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

iban

o


Excerpt Include
bic - definition
bic - definition
nopaneltrue

bic

o


Excerpt Include
bic - definition
bic - definition
nopaneltrue

bankaccount

o


Excerpt Include
bankaccount - definition
bankaccount - definition
nopaneltrue

bankcode

o


Excerpt Include
bankcode - definition
bankcode - definition
nopaneltrue

bankgrouptype

o


Excerpt Include
bankgrouptype - definition
bankgrouptype - definition
nopaneltrue

successurl

o+


Excerpt Include
successurl - definition
successurl - definition
nopaneltrue

errorurl

o+


Excerpt Include
errorurl - definition
errorurl - definition
nopaneltrue

backurl

o+


Excerpt Include
backurl - definition
backurl - definition
nopaneltrue

Parameter ( e-wallet )

wallettype

+


Excerpt Include
wallettype - definition
wallettype - definition
nopaneltrue

successurl

o+


Excerpt Include
successurl - definition
successurl - definition
nopaneltrue

errorurl

o+


Excerpt Include
errorurl - definition
errorurl - definition
nopaneltrue

backurl

o+


Excerpt Include
backurl - definition
backurl - definition
nopaneltrue

it[n]

o


Excerpt Include
it[n] - definition
it[n] - definition
nopaneltrue

id[n]

o


Excerpt Include
id[n] - definition
id[n] - definition
nopaneltrue

pr[n]

o


Excerpt Include
pr[n] - definition
pr[n] - definition
nopaneltrue

no[n]

Excerpt Include
no[n] - definition
no[n] - definition
nopaneltrue

de[n]

o


Excerpt Include
de[n] - definition
de[n] - definition
nopaneltrue

va[n]

o


Excerpt Include
va[n] - definition
va[n] - definition
nopaneltrue

Parameter ( cash on delivery )

shippingprovider

+


Excerpt Include
shippingprovider - definition
shippingprovider - definition
nopaneltrue

Parameter ( credit card )

cardpan

+


Excerpt Include
cardpan - definition
cardpan - definition
nopaneltrue

cardtype

+


Excerpt Include
cardtype - definition
cardtype - definition
nopaneltrue

cardexpiredate

+


Excerpt Include
cardexpiredate - definition
cardexpiredate - definition
nopaneltrue

cardcvc2

o


Excerpt Include
cardcvc2 - definition
cardcvc2 - definition
nopaneltrue

cardissuenumber

-



cardholder

-


Excerpt Include
cardholder - definition
cardholder - definition
nopaneltrue

ecommercemode-

Excerpt Include
ecommercemode - definition
ecommercemode - definition
nopaneltrue

Parameter ( credit card with pseudo card number )

pseudocardpan

+


Excerpt Include
pseudocardpan - definition
pseudocardpan - definition
nopaneltrue

Parameter ( 3-D Secure )

xid

o


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

Excerpt Include
xid - definition
xid - definition
nopaneltrue

cavv

-


Excerpt Include
cavv - definition
cavv - definition
nopaneltrue

eci

-


Excerpt Include
eci - definition
eci - definition
nopaneltrue

successurl

o+


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

Excerpt Include
successurl - definition
successurl - definition
nopaneltrue

errorurl

o+


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

Excerpt Include
errorurl - definition
errorurl - definition
nopaneltrue

backurl

o+


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

Excerpt Include
backurl - definition
backurl - definition
nopaneltrue

Parameter ( Financing )

financingtype

+


Excerpt Include
financingtype - definition
financingtype - definition
nopaneltrue

workorderid

o


Excerpt Include
workorderid - definition
workorderid - definition
nopaneltrue

it[n]

+


Excerpt Include
it[n] - definition
it[n] - definition
nopaneltrue

id[n]

+


Excerpt Include
id[n] - definition
id[n] - definition
nopaneltrue

pr[n]

+


Excerpt Include
pr[n] - definition
pr[n] - definition
nopaneltrue

no[n]

+


Excerpt Include
no[n] - definition
no[n] - definition
nopaneltrue

de[n]

+


Excerpt Include
de[n] - definition
de[n] - definition
nopaneltrue

va[n]

-


Excerpt Include
va[n] - definition
va[n] - definition
nopaneltrue


Response "preauthorization"

Common Parameter

RequiredFormatComment

status

+


APPROVED / REDIRECT / ERROR / PENDING

Parameter (APPROVED)

txid

+


Excerpt Include
txid - definition
txid - definition
nopaneltrue

userid

+


Excerpt Include
userid - definition
userid - definition
nopaneltrue

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

txid

+


Excerpt Include
txid - definition
txid - definition
nopaneltrue

userid

+


Excerpt Include
userid - definition
userid - definition
nopaneltrue

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

txid

+


Excerpt Include
txid - definition
txid - definition
nopaneltrue

userid

+


Excerpt Include
userid - definition
userid - definition
nopaneltrue

redirecturl

+


Excerpt Include
redirecturl - definition
redirecturl - definition
nopaneltrue

Parameter (ERROR)

errorcode

+


Excerpt Include
errorcode - definition
errorcode - definition
nopaneltrue

errormessage

+


Excerpt Include
errormessage - definition
errormessage - definition
nopaneltrue

customermessage

-


Excerpt Include
customermessage - definition
customermessage - definition
nopaneltrue

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

Excerpt Include
mandate_identification - definition
mandate_identification - definition
nopaneltrue

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

Table of Contents
excludeContent