Introduction

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.

More Information on creditcardcheck with Checktype TC (Travel Card) you can find here.

POST Request - creditcardcheck
Account Parameters
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

---end

Common Parameters
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. 

---end

cardtype
optional
Format LIST
Fixed value V

The Parameter “cardtype” can be dropped and then the PAYONE Platform will return the cardtype in the response depending on the given cardpan.
This cardtype has then be passed for future requests (like “preauthorization” / “authorization”)

BIN range for automatic card type detection

---end

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.

---end

cardissuenumber
optional
Format NUMERIC(1..2)

Card issue number (only Maestro UK cards)

storecarddata
optional
Format LIST
Value Comment
no Card data is not stored
yes Card data is stored, a pseudo card number is returned

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

See Special remarks - creditcardcheck with Checktype TC for details

only available for select merchants

---end


---end

Response Parameters

Permitted Values

VALID
INVALID
ERROR

---end

Response parameters (Valid)
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
Fixed value V

Card type of credit card 

value

Comment

BIN-Range for automatic card type detection

V

Visa

4

M

MasterCard

51-55,2221-2720

A

American Express

34, 37
D Diners / Discover

300-305,3095,36,38,39

601, 64, 65

C Discover

J

JCB

3528-3589

O

Maestro International

50, 56-58,602, 61, 620, 627, 63, 67
P China Union Pay 62212600-62299800,624-626, 6282-6288
U UATP / Airplus 1220, 1920 -> coming soon; not available yet
G girocard 68 *
cardexpiredate
Format NUMERIC(4), YYMM

Credit card expiry date YYMM 

 ---

Response parameters (INvalid) - card number invalid
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")

 ---

Response parameters (error)
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")

---end

Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
                        
https://api04.fra.pay1.de/post-gateway/
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