Skip to end of metadata
Go to start of metadata

Checks the card for participation in the 3-D Secure procedure and initiates a 3-D Secure session if required.

Additionally, this request offers the possibility to store credit card data. In this case, the response submits what is known as a pseudo card number.

Request "3dscheck"

Common Parameter

Required

Format

Comment

aid

+


Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

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

clearingtype

+


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

exiturl

+


Exit-URL to be forwarded after authentication on the ACS

Format

CHAR(2..255)

cardpan

o


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.

pseudocardpan

o


Pseudo primary account number for a credit card.

Format

NUMERIC(16..19)

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
Ggirocard68 *

*girocard is currently only viable for e-commerce-payments via Apple Pay.

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.

storecarddata

-


Specifies whether a pseudocardnumber shall be generated for later use (e.g. payment request)

Format

LIST 
ValueComment
no

Card data is not stored

yes

Card data is stored, a pseudo card number is returned

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

Response "3dscheck"

Common Parameter

Required

Format

Comment

status

+

Default

VALID                     card number valid

INVALID                 card number invalid

ENROLLED             card participates

ERROR                   request faulty

Parameter (VALID)

xid

+


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

Format

CHAR(1..60)

pseudocardpan

o


Pseudo primary account number for a credit card.

Format

NUMERIC(16..19)

truncatedcardpan

o


Masked cardpan, i.e. 411111xxxxxx1111 (is returned if storecarddata=yes)

Format

CHAR(13..19)

Parameter (ENROLLED)

acsurl

+

AN..255

ACS URL

-> redirect customer to this URL. Here the customer will have to complete 3-D authorization at his bank.

-> add response-values for “termurl”, “pareq” and “md” as post data while redirecting

termurl

+

AN.255

URL of the PAYONE Platform validation page

-> add this response-value with key “TermUrl” to post data while redirecting to returned acsurl

pareq

+

AN..1000

Request message to ACS

-> add this response-value with key “PaReq” to post data while redirecting to returned acsurl

md

+

N..12

"Merchant Data" includes the PAYONE Platform reference ID

-> add this response-value with key “MD” to post data while redirecting to returned acsurl

xid

+


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

Format

CHAR(1..60)

pseudocardpan

o


Pseudo primary account number for a credit card.

Format

NUMERIC(16..19)

truncatedcardpan

o


Masked cardpan, i.e. 411111xxxxxx1111 (is returned if storecarddata=yes)

Format

CHAR(13..19)

Parameter (INVALID)

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


  • No labels