The CreditCardCheck checks credit cards for plausibility in real-time.
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 - creditcardcheck
| request
required
|
Fixed Value: creditcardcheck
|
| 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
|
| 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. |
||||||
| cardtype optional
|
Format LIST
The Parameter “cardtype” can be dropped and then the PAYONE Platform will return the cardtype in the response depending on the given cardpan. BIN range for automatic card type detection |
||||||
| cardexpiredate required
|
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.
|
||||||
| cardissuenumber optional
|
Format NUMERIC(1..2)
Card issue number (only Maestro UK cards) |
||||||
| 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. |
||||||
| checktype optional
|
Only available for select merchants |
|
Permitted Values
VALID
INVALID
ERROR |
| 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) |
| cardtype |
Format LIST
Card type of credit card |
| cardexpiredate |
Format NUMERIC(4), YYMM
Credit card expiry date YYMM |
| 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
aid=52078
api_version=3.8
callback_method=PayoneGlobals.callback
cardexpiredate=2504
cardexpiremonth=4
cardexpireyear=2025
cardpan=411111xxxxxx1111
cardtype=V
channel=clientapi
channelDetail=payoneHosted
encoding=UTF-8
hash=f5aa284c7cef8dfb3e289290bc47d236
key=17031f73e2c6f9755788bddfff04169b
mid=14648
mode=test
portalid=2037267
request=creditcardcheck
responsetype=JSON
storecarddata=yes
RESPONSE
status=VALID
cardtype=V
pseudocardpan=9410010000038248746
truncatedcardpan=411111XXXXXX1111
cardexpiredate=2504