HomeDocumentationAPI Reference
API Reference

Card details

If you adhere to the requirements of PCI DSS SAQ-A-EP, you may add card details to the checkout, authorize, and/or openContract request in the card query string parameter, separate from the main request body. Consequently, the signature calculation does not include the card details. You can also pass card details to Reach via the Stash request.

FieldTypeRequiredNotes
NumberstringYesThe card number, without punctuation or whitespace.
NamestringYesThe cardholder's name as it appears on the card.
ExpiryobjectYesThe expiration date of the card.
> YearintegerYesThe expiration year is unabbreviated (e.g., 2020).
> MonthintegerYesThe expiry month, 1-12.
VerificationCodestringNoThe card verification code. Although these are typically digits, leading zeros are significant, so this must be transmitted as a string. You may omit the verification code only if you specify the PreviousNetworkPaymentReference.
PreviousNetworkPaymentReferencestringNoSuppose the card details are from a vault. In that case, you can use the card network payment reference (e.g., VISA transaction ID) of a previous payment using the same card instead of a VerificationCode.