Skip to content
Skip to breadcrumbs
Skip to header menu
Skip to action menu
Skip to quick search

Page History

Versions Compared

Key

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

Glossary navigation bar

Meaning: Specifies country for the customer

Format: Default, upper case

Permitted values: ISO-3166, 2-letter-codes, e.g. DE, GB, US. Some countries require additional information in parameter "state"

Reference: see ISO Countries (ISO 3166)

Request restrictions:

Glossary term

Glossary term

dateTerm	Fri May 03 17:09:44 CEST 2019
termLabels	apiparam
gloTerm	clearingtype
creatorTerm	payone-admin

clearingtype

Description

Comment

elv

Debit payment

cc

Credit card

rec

Invoice

cod

Cash on delivery

not allowed for vauthorization, createaccess

vor

Prepayment

not allowed for vauthorization, createaccess

sb

Online Bank Transfer

not allowed for vauthorization, createaccess

wlt

e-wallet

not allowed for vauthorization, createaccess

fnc

Financing

not allowed for vauthorization, createaccess

Glossary term

dateTerm	Fri May 03 18:05:05 CEST 2019
termLabels	apiparam
gloTerm	country
creatorTerm	payone-admin

request

Comments

addresscheck

Check “BB”, “PB”: only “DE” supported

consumerscore

only “DE” supported

Glossary term

dateTerm	Fri May 03 18:06:55 CEST 2019
termLabels	apiparam
gloTerm	currency
creatorTerm	payone-admin

Meaning: Specifies currency for this transaction

Format: Default, upper case

Permitted values: ISO-4217, 3-letter-codes, e.g. EUR or USD

Reference: see ISO Currencies (ISO 4217)

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

Format: AN1..20

Permitted symbols: 0-9, a-z, A-Z, .,-,_,/

dateTerm	Fri May 03 18:14:35 CEST 2019
termLabels	apiparam
gloTerm	clearingsubtype
creatorTerm	payone-admin
termSyns	financingtype, wallettype

Only valid with “clearingtype=rec”.

Used for PAYONE Secure Invoice

clearingsubtype	Comments
POV	PAYONE secure purchase on invoice

Glossary term

dateTerm	Mon May 06 12:46:19 CEST 2019
termLabels	apiparam
gloTerm	customerid
creatorTerm	payone-admin

UI Text Box

type	tip

"customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically.

Glossary term

dateTerm	Mon May 06 15:49:34 CEST 2019
termLabels	apiresponse
gloTerm	customermessage
creatorTerm	payone-admin

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

The language of the customermessage is specified by the parameter language.

Meaning: Credit card security number

Format: N..4

Permitted symbols: 0-9

Glossary term

dateTerm	Mon May 06 18:13:08 CEST 2019
termLabels	apiparam
gloTerm	cardcvc2
creatorTerm	payone-admin

UI Text Box

type	warning

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

Glossary term

dateTerm	Mon May 06 19:06:19 CEST 2019
termLabels	apiparam
gloTerm	city
creatorTerm	payone-admin

Meaning: City

Format: AN2..50

Payment specific:

Payment typeCommentsKLV, KLSMandatoryPYV, PYM,
PYS, PYDMandatoryELV

Mandatory for direct debit (ELV) used with IBAN-countries CH, SM, MC, PM, JE, GG

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. This takes effect when “capture” is done.

Glossary term

dateTerm	Thu May 09 13:52:27 CEST 2019
termLabels	apiparam
gloTerm	cardpan
creatorTerm	payone-admin

Meaning: Primary account number of credit card

Format: N..19

UI Text Box

type	warning

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.

Meaning: Indicates whether customer is present or not.

Values

Meaning: 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: AN2..50

Payment specific:

Meaning: Specifies whether this capture is the last one or whether there will be another one in future.

Values:

Payment specific;

Meaning: Cardholder of credit card.

Format: AN..50

Permitted symbols: A-Z, a-z, 0-9

Glossary term

dateTerm	Thu May 09 13:53:52 CEST 2019
termLabels	apiparam
gloTerm	cardtype
creatorTerm	payone-admin

Meaning: Card type of credit card

Format: Default

cardtype	Comments
V	Visa
M	MasterCard
A	American Express
D	Diners / Discover
C	~~Discover~~
J	JCB
O	Maestro International
P	China Union Pay

Request specific:

request

Comments

creditcardcheck

Parameter "cardtype" can be omitted. The card type will then be detected automatically and returned in response.

preauthorization

authorization

vauthorization

createaccess

Parameter "cardtype" must be present for credit card payments. Value for "cardtype" can be retrieved from creditcardcheck-response.

Glossary term

dateTerm	Tue May 14 14:40:34 CEST 2019
termLabels	apiparam
gloTerm	customer_is_present
creatorTerm	payone-admin

customer_is_present

Comments

yes

Customer is “present” and can enter his/her data in the shop.

no

Customer is not present and can not enter any data.

Glossary term

dateTerm	Tue May 14 14:45:34 CEST 2019
termLabels	apiparam
gloTerm	company
creatorTerm	payone-admin

Payment type

Comments

PNT

Company name is limited to 27 characters

Glossary term

dateTerm	Tue May 14 17:31:00 CEST 2019
termLabels	apiparam
gloTerm	capturemode
creatorTerm	jkillmer

capturemode

Comments

completed

Set with last capture; i.e.: Delivery completed.
No further capture is allowed.

notcompleted

Set with partial deliveries (last delivery with "completed")
Another capture is expected to complete the transaction.

Payment type

Comments

PDT

Parameter "capturemode" is mandatory.

KLV, KLS

Parameter "capturemode" is mandatory.

Glossary term

dateTerm	Wed May 15 15:43:56 CEST 2019
termLabels	apiparam
gloTerm	cardholder
creatorTerm	jkillmer

UI Text Box

type	tip

the card holder is normally not sent to the acquirer and is just for information
if the card holder is not specified the PAYONE platform will use firstname / lastname for card holder - if required

Glossary termdateTermMon May 20 17:18:10 CEST 2019termLabelsapiparamgloTermcardexpiredatetermAbbrscreatorTermjkillmertermSyns

Meaning: Expiry date YYMM

Format: N.

.

4, YYMMPermitted symbols: 0-9

Glossary term

dateTerm	Thu May 23 13:11:39 CEST 2019
termLabels	apiparam
gloTerm	checktype
termAbbrs
creatorTerm	jkillmer
termSyns

Meaning: Specifies type of check to be performed, e.g. creditcardcheck or bankaccountcheck

Values:

Request	checktype	Comments
bankaccountcheck	0	regular check (default) IBAN is checked for correct syntax (mode live only) IBAN is splitted into BBAN (mode live only)
bankaccountcheck	1	check against POS blacklist (only DE)
bankaccountcheck	2	check against NCA list (non-consumer account)
creditcardcheck		without "checktype" given the regular check is performed (LUHN-check)
creditcardcheck	TC	For Deutsche Bahn only: check for travelcards with specific response data

...