creditCard

Contains the details for a specific credit card, such as the card number and expiration date

Request

Property NameTypeRequiredDescription
cardLastFourDigitsstring

Optional

Required if sending a vaulted shopper ID and the shopper has multiple saved credit cards.

Last four digits of the credit card.
cardNumberstring

Required if encryptedCardNumber is not sent.

Optional if sending a vaulted shopper ID.

Credit card number. Maximum 21 characters.
For example:
  • 4111111111111111
  • 4111-1111-1111-1111
  • 4111 1111 1111 1111
cardTypestring

Optional if sending cardNumber or encryptedCardNumber.

Note: If BlueSnap identifies that the card type is different than what you send, the transaction will fail. If you do not send the cardType, BlueSnap will automatically identify the type based on the number. You can check the card type for a specific number using the Retrieve Card Info request.

Required if sending a vaulted shopper ID and the shopper has multiple saved credit cards.

Credit card type.

Possible Values:
  • AMEX
  • ARGENCARD
  • CABAL
  • CARTE_BLEUE
  • CENCOSUD
  • CHINA_UNION_PAY
  • DANKORT
  • DINERS
  • DISCOVER
  • ELO
  • HIPERCARD
  • JCB
  • MAESTR_UK
  • MASTERCARD
  • NARANJA
  • SOLO
  • TARJETASHOPPING
  • VISA
encryptedCardNumberstring

Required if cardNumber is not sent.

Optional if sending a vaulted shopper ID.

Encrypted credit card number.
encryptedSecurityCodestring

Optional

Relevant if securityCode is not sent.

N/A for batch transactions

Encrypted credit card security code.
expirationMonthstring

Required

Optional if sending a vaulted shopper ID.

Credit card expiration month.
expirationYearstring

Required

Optional if sending a vaulted shopper ID.

Credit card expiration 4-digit year.
securityCodestring

Optional

Relevant if encryptedSecurityCode is not sent.

N/A for batch transactions

Credit card security code. Should be 4 characters for American Express or 3 characters for any other card type.
securityCodePfTokenstring

Optional

Relevant if using Hosted Payment Fields.

Hosted Payment Fields token that has been associated with a shopper's CVV. Useful for verifying CVV when shopper uses a saved card.

Response

Property NameTypeDescription
binCategorystringIndicates whether the card is used for business expenses (Commercial) or personal expenses (Consumer).
binNumberstringThe Bank Identification Number (BIN) on the customer's payment card. This is the first 4 to 6 digits of the credit card number and is used to identify the institution that issued the card.
cardCategorystringCard category, such as business or prepaid.
Appears only if relevant.
cardLastFourDigitsstringLast four digits of the credit card.
cardRegulatedstring

Indicates whether the card is regulated.

Values:
  • Y
  • N
cardSubTypestringCard sub-type, such as Credit or Debit
cardTypestringCredit card type.
expirationMonthstring

Credit card expiration month.

Appears only in responses for Create and Retrieve Vaulted Shopper.

expirationYearstring

Credit card expiration 4-digit year.

Appears only in responses for Create and Retrieve Vaulted Shopper.

issuingBankstringThe bank that issued the shopper's card.
issuingCountryCodestringCountry code of the shopper's issuing bank.