Page History

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

Required

Format

Comment

aid

+

Excerpt Include

	aid - definition
	aid - definition
nopanel	true

clearingtype

Excerpt Include

	clearingtype - definition
	clearingtype - definition
nopanel	true

reference

+

Excerpt Include

	reference - definition
	reference - definition
nopanel	true

amount

+

Excerpt Include

	amount - definition
	amount - definition
nopanel	true

currency

+

Excerpt Include

	currency - definition
	currency - definition
nopanel	true

param

-

Excerpt Include

	param - definition
	param - definition
nopanel	true

narrative_text

-

Excerpt Include

	narrative_text - definition
	narrative_text - definition
nopanel	true

customer_is_present

-

Excerpt Include

	customer_is_present - definition
	customer_is_present - definition
nopanel	true

recurrence

-

Excerpt Include

	recurrence - definition
	recurrence - definition
nopanel	true

Parameter ( PAYONE Secure Invoice )

clearingsubtype

+

Excerpt Include

	clearingsubtype - definition
	clearingsubtype - definition
nopanel	true

Parameter ( personal data )

customerid

-

Excerpt Include

	customerid - definition
	customerid - definition
nopanel	true

userid

-

Excerpt Include

	userid - definition
	userid - definition
nopanel	true

businessrelation

o

Excerpt Include

	businessrelation - definition
	businessrelation - definition
nopanel	true

salutation

-

Excerpt Include

	salutation - definition
	salutation - definition
nopanel	true

title

-

Excerpt Include

	title - definition
	title - definition
nopanel	true

firstname

o

Excerpt Include

	firstname - definition
	firstname - definition
nopanel	true

lastname

+

Excerpt Include

	lastname - definition
	lastname - definition
nopanel	true

company

-

Excerpt Include

	company - definition
	company - definition
nopanel	true

street

-

Excerpt Include

	street - definition
	street - definition
nopanel	true

addressaddition

-

Excerpt Include

	addressaddition - definition
	addressaddition - definition
nopanel	true

zip

-

Excerpt Include

	zip - definition
	zip - definition
nopanel	true

city

-

Excerpt Include

	city - definition
	city - definition
nopanel	true

country

+

Excerpt Include

	country - definition
	country - definition
nopanel	true

state

-

Excerpt Include

	state - definition
	state - definition
nopanel	true

email

-

Excerpt Include

	email - definition
	email - definition
nopanel	true

telephonenumber

-

Excerpt Include

	telephonenumber - definition
	telephonenumber - definition
nopanel	true

birthday

-

Excerpt Include

	birthday - definition
	birthday - definition
nopanel	true

language

-

Excerpt Include

	language - definition
	language - definition
nopanel	true

vatid

-

Excerpt Include

	vatid - definition
	vatid - definition
nopanel	true

gender

-

Excerpt Include

	gender - definition
	gender - definition
nopanel	true

personalid

-

Excerpt Include

	personalid - definition
	personalid - definition
nopanel	true

ip

-

Excerpt Include

	ip - definition
	ip - definition
nopanel	true

Parameter ( delivery data )

shipping_firstname

-

Excerpt Include

	shipping_firstname - definition
	shipping_firstname - definition
nopanel	true

shipping_lastname

-

Excerpt Include

	shipping_lastname - definition
	shipping_lastname - definition
nopanel	true

shipping_company

-

Excerpt Include

	shipping_company - definition
	shipping_company - definition
nopanel	true

shipping_street

-

Excerpt Include

	shipping_street - definition
	shipping_street - definition
nopanel	true

shipping_zip

-

Excerpt Include

	shipping_zip - definition
	shipping_zip - definition
nopanel	true

shipping_addressaddition

-

Excerpt Include

	shipping_addressaddition - definition
	shipping_addressaddition - definition
nopanel	true

shipping_city

-

Excerpt Include

	shipping_city - definition
	shipping_city - definition
nopanel	true

shipping_state

o

Excerpt Include

	shipping_state - definition
	shipping_state - definition
nopanel	true

shipping_country

-

Excerpt Include

	shipping_country - definition
	shipping_country - definition
nopanel	true

Parameter ( debit payment )

iban

o

Excerpt Include

	iban - definition
	iban - definition
nopanel	true

bic

o

Excerpt Include

	bic - definition
	bic - definition
nopanel	true

bankcountry

o

Excerpt Include

	bankcountry - definition
	bankcountry - definition
nopanel	true

bankaccount

o

Excerpt Include

	bankaccount - definition
	bankaccount - definition
nopanel	true

bankcode

o

Excerpt Include

	bankcode - definition
	bankcode - definition
nopanel	true

bankaccountholder

o

Excerpt Include

	bankaccountholder - definition
	bankaccountholder - definition
nopanel	true

mandate_identification

o

Excerpt Include

	mandate_identification - definition
	mandate_identification - definition
nopanel	true

Parameter ( online transfer )

onlinebanktransfertype

+

Excerpt Include

	onlinebanktransfertype - definition
	onlinebanktransfertype - definition
nopanel	true

bankcountry

+

Default

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

iban

o

Excerpt Include

	bic - definition
	bic - definition
nopanel	true

bic

o

Excerpt Include

	bic - definition
	bic - definition
nopanel	true

bankaccount

o

Excerpt Include

	bankaccount - definition
	bankaccount - definition
nopanel	true

bankcode

o

Excerpt Include

	bankcode - definition
	bankcode - definition
nopanel	true

bankgrouptype

o

Excerpt Include

	bankgrouptype - definition
	bankgrouptype - definition
nopanel	true

successurl

+

Excerpt Include

	successurl - definition
	successurl - definition
nopanel	true

errorurl

+

Excerpt Include

	errorurl - definition
	errorurl - definition
nopanel	true

backurl

+

Excerpt Include

	backurl - definition
	backurl - definition
nopanel	true

Parameter ( e-wallet )

wallettype

+

Excerpt Include

	wallettype - definition
	wallettype - definition
nopanel	true

successurl

+

Excerpt Include

	successurl - definition
	successurl - definition
nopanel	true

errorurl

+

Excerpt Include

	errorurl - definition
	errorurl - definition
nopanel	true

backurl

+

Excerpt Include

	backurl - definition
	backurl - definition
nopanel	true

it[n]

o

Excerpt Include

	it[n] - definition
	it[n] - definition
nopanel	true

id[n]

o

Excerpt Include

	id[n] - definition
	id[n] - definition
nopanel	true

pr[n]

o

Excerpt Include

	pr[n] - definition
	pr[n] - definition
nopanel	true

no[n]

Excerpt Include

	no[n] - definition
	no[n] - definition
nopanel	true

de[n]

o

Excerpt Include

	de[n] - definition
	de[n] - definition
nopanel	true

va[n]

o

Excerpt Include

	va[n] - definition
	va[n] - definition
nopanel	true

Parameter ( cash on delivery )

shippingprovider

+

Excerpt Include

	shippingprovider - definition
	shippingprovider - definition
nopanel	true

Parameter ( credit card )

cardpan

+

Excerpt Include

	cardpan - definition
	cardpan - definition
nopanel	true

cardtype

+

Excerpt Include

	cardtype - definition
	cardtype - definition
nopanel	true

cardexpiredate

+

Excerpt Include

	cardexpiredate - definition
	cardexpiredate - definition
nopanel	true

cardcvc2

o

Excerpt Include

	cardcvc2 - definition
	cardcvc2 - definition
nopanel	true

cardissuenumber

-

cardholder

-

Excerpt Include

	cardholder - definition
	cardholder - definition
nopanel	true

ecommercemode

-

Excerpt Include

	ecommercemode - definition
	ecommercemode - definition
nopanel	true

Parameter ( credit card with pseudo card number )

pseudocardpan

+

Excerpt Include

	pseudocardpan - definition
	pseudocardpan - definition
nopanel	true

Parameter ( 3-D Secure )

xid

o

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

Excerpt Include

	xid - definition
	xid - definition
nopanel	true

cavv

-

Excerpt Include

	cavv - definition
	cavv - definition
nopanel	true

eci

-

Excerpt Include

	eci - definition
	eci - definition
nopanel	true

successurl

+

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

Excerpt Include

	successurl - definition
	successurl - definition
nopanel	true

errorurl

+

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

Excerpt Include

	errorurl - definition
	errorurl - definition
nopanel	true

backurl

+

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

Excerpt Include

	backurl - definition
	backurl - definition
nopanel	true

Parameter ( Financing )

financingtype

+

Excerpt Include

	financingtype - definition
	financingtype - definition
nopanel	true

workorderid

o

Excerpt Include

	workorderid - definition
	workorderid - definition
nopanel	true

it[n]

+

Excerpt Include

	it[n] - definition
	it[n] - definition
nopanel	true

id[n]

+

Excerpt Include

	id[n] - definition
	id[n] - definition
nopanel	true

pr[n]

+

Excerpt Include

	pr[n] - definition
	pr[n] - definition
nopanel	true

no[n]

+

Excerpt Include

	no[n] - definition
	no[n] - definition
nopanel	true

de[n]

+

Excerpt Include

	de[n] - definition
	de[n] - definition
nopanel	true

va[n]

-

Excerpt Include

	va[n] - definition
	va[n] - definition
nopanel	true

Response "preauthorization"

Common Parameter

Required

Format

Comment

status

+

APPROVED / REDIRECT / ERROR / PENDING

Parameter (APPROVED)

txid

+

Excerpt Include

	txid - definition
	txid - definition
nopanel	true

userid

+

Excerpt Include

	userid - definition
	userid - definition
nopanel	true

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

txid

+

Excerpt Include

	txid - definition
	txid - definition
nopanel	true

userid

+

Excerpt Include

	userid - definition
	userid - definition
nopanel	true

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

txid

+

Excerpt Include

	txid - definition
	txid - definition
nopanel	true

userid

+

Excerpt Include

	userid - definition
	userid - definition
nopanel	true

redirecturl

+

Excerpt Include

	redirecturl - definition
	redirecturl - definition
nopanel	true

Parameter (ERROR)

errorcode

+

Excerpt Include

	errorcode - definition
	errorcode - definition
nopanel	true

errormessage

+

Excerpt Include

	errormessage - definition
	errormessage - definition
nopanel	true

customermessage

-

Excerpt Include

	customermessage - definition
	customermessage - definition
nopanel	true

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
nopanel	true

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

exclude	Content

Page tree

Versions Compared

Old Version 77

New Version 78

Key

Introduction

Request "preauthorization"

Common Parameter

Parameter ( PAYONE Secure Invoice )

Parameter ( personal data )

Parameter ( delivery data )

Parameter ( debit payment )

Parameter ( online transfer )

Parameter ( e-wallet )

Parameter ( cash on delivery )

Parameter ( credit card )

Parameter ( credit card with pseudo card number )

Parameter ( 3-D Secure )

Parameter ( Financing )

Response "preauthorization"

Common Parameter

Parameter (APPROVED)

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

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

Parameter (ERROR)

Parameter ( credit card – if AVS has been ordered )

Parameter ( Prepayment/cash on delivery )

Parameter ( direct debit )

Content

Social Media

PAYONE

Help

Intranet Tools