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.
POST Request - 3dscheck
Account Parameters
| request
required
|
Fixed Value: 3dscheck
|
| mid
required
|
your merchant ID, 5-digit numeric
|
| aid
required
|
your subaccount ID, 5-digit numeric
|
| portalId
required
|
your Portal ID, 7-digit numeric
|
| key
required
|
your key value, alpha-numeric
|
| channel required
|
Fixed Value: clientapi
|
| channelDetail required
|
Permitted Value: payoneHosted
|
| clearingtype
required
|
Format LIST
|
||||||||||||||||||||
| amount
required
|
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99 Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro. The amount must be less than or equal to the amount of the corresponding booking. |
||||||||||||||||||||
| currency
required
|
Fixed Value EUR
|
||||||||||||||||||||
| exiturl required
|
Format CHAR(1..255)
Exit-URL to be forwarded after authentication on the ACS |
||||||||||||||||||||
| cardpan required
|
Format NUMERIC(13..19)
Primary account number of credit card 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 optional
|
Format LIST
Card type of credit card |
||||||||||||||||||||
| cardexpiredate optional
|
Format NUMERIC(4), YYMM
Credit card expiry date YYMM |
||||||||||||||||||||
| cardcvc2 optional
|
Format NUMERIC(3..4)
Credit card security number For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used.
|
||||||||||||||||||||
| pseudocardpan optional
|
Format NUMERIC(16..19)
Pseudo primary account number for a credit card. |
||||||||||||||||||||
| storecarddata optional
|
Format LIST
Specifies whether a pseudocardnumber shall be generated for later use (e.g. payment request) |
||||||||||||||||||||
| language optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes
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. |
|
Permitted Values VALID (card number valid)
INVALID (card number invalid)
ENROLLED (card participates)
ERROR (request faulty) |
| pseudocardpan |
Format NUMERIC(16..19)
Pseudo primary account number for a credit card. This token is unique per merchant and cardpan/expiredate and can be used in any payment-request with credit cards to refer to an existing credit card in the PAYONE platform. |
| truncatedcardpan |
Format CHAR(13..19)
Masked cardpan, i.e. 411111xxxxxx1111 (is returned if storecarddata=yes) |
| xid |
Format CHAR(1..60)
3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.: value for "xid" is returned by request 3dscheck (optional request) |
| acsurl |
Format 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 |
Format AN..1000
URL of the PAYONE Platform validation page -> add this response-value with key “TermUrl” to post data while redirecting to returned acsurl |
| pareq |
Format AN..255
Request message to ACS -> add this response-value with key “PaReq” to post data while redirecting to returned acsurl |
| md |
Format 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 |
| pseudocardpan |
Format NUMERIC(16..19)
Pseudo primary account number for a credit card. This token is unique per merchant and cardpan/expiredate and can be used in any payment-request with credit cards to refer to an existing credit card in the PAYONE platform. |
| truncatedcardpan |
Format CHAR(13..19)
Masked cardpan, i.e. 411111xxxxxx1111 (is returned if storecarddata=yes) |
| xid |
Format CHAR(1..60)
3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.: value for "xid" is returned by request 3dscheck (optional request) |
| errorcode |
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
| errormessage |
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
| customermessage |
Format CHAR(1..1024)
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") |
| errorcode |
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
| errormessage |
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
| customermessage |
Format CHAR(1..1024)
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
RESPONSE