{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"creditCard","type":"basic","slug":"credit-card","excerpt":"Contains the details for a specific credit card, such as the card number and expiration date","body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`cardNumber`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Credit card number. Maximum 21 characters. \\nFor example:\\n * 4111111111111111\\n * 4111-1111-1111-1111\\n * 4111 1111 1111 1111\",\n \"1-0\": \"`encryptedCardNumber`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"Encrypted credit card number.\",\n \"h-4\": \"Description\",\n \"0-2\": \"**Required** if `encryptedCardNumber` is not sent.\\n\\nOptional if sending a vaulted shopper ID.\",\n \"1-2\": \"**Required** if `cardNumber` is not sent.\\n\\nOptional if sending a vaulted shopper ID.\",\n \"2-0\": \"`cardLastFourDigits`\",\n \"2-1\": \"*string*\",\n \"2-3\": \"Last four digits of the credit card.\",\n \"2-2\": \"Optional\\n\\n**Required** if sending a vaulted shopper ID and the shopper has multiple saved credit cards.\",\n \"3-0\": \"`cardType`\",\n \"4-0\": \"`expirationMonth`\",\n \"5-0\": \"`expirationYear`\",\n \"6-0\": \"`securityCode`\",\n \"7-0\": \"`encryptedSecurityCode`\",\n \"3-1\": \"*string*\",\n \"6-1\": \"*string*\",\n \"7-1\": \"*string*\",\n \"4-1\": \"*integer*\",\n \"5-1\": \"*integer*\",\n \"3-2\": \"Optional if sending `cardNumber` or `encryptedCardNumber`.\\n\\n**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](/v8976-Tools/docs/retrieve-card-info) request.\\n\\n**Required** if sending a vaulted shopper ID and the shopper has multiple saved credit cards.\",\n \"4-2\": \"**Required**\\n\\nOptional if sending a vaulted shopper ID.\",\n \"5-2\": \"**Required**\\n\\nOptional if sending a vaulted shopper ID.\",\n \"6-2\": \"Optional\\n\\nRelevant if `encryptedSecurityCode` is not sent. \\n\\nN/A for batch transactions\",\n \"7-2\": \"Optional\\n\\nRelevant if `securityCode` is not sent. \\n\\nN/A for batch transactions\",\n \"3-3\": \"Credit card type.\\n\\n**Possible Values**:\\n * `AMEX`\\n * `ARGENCARD`\\n * `CABAL` \\n * `CARTE_BLEUE`\\n * `CENCOSUD`\\n * `CHINA_UNION_PAY`\\n * `DANKORT`\\n * `DINERS`\\n * `DISCOVER`\\n * `ELO`\\n * `HIPERCARD`\\n * `JCB`\\n * `MAESTR_UK`\\n * `MASTERCARD`\\n * `NARANJA`\\n * `SOLO`\\n * `TARJETASHOPPING`\\n * `VISA`\",\n \"4-3\": \"Credit card expiration month.\",\n \"5-3\": \"Credit card expiration 4-digit year.\",\n \"6-3\": \"Credit card security code. Should be 4 characters for American Express or 3 characters for any other card type.\",\n \"7-3\": \"Encrypted credit card security code.\",\n \"8-0\": \"`securityCodePfToken`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"Optional \\n\\nRelevant if using Hosted Payment Fields.\",\n \"8-3\": \"Hosted Payment Fields token that has been associated with a shopper's CVV. Useful for verifying CVV when shopper uses a saved card.\"\n },\n \"cols\": 4,\n \"rows\": 9\n}\n[/block]\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`cardLastFourDigits`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"1-0\": \"`cardType`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"BlueSnap identifier for the transaction.\",\n \"h-4\": \"Description\",\n \"0-2\": \"Last four digits of the credit card.\",\n \"1-2\": \"Credit card type.\",\n \"9-0\": \"`expirationMonth`\",\n \"9-1\": \"*integer*\",\n \"9-3\": \"Amount to be charged in the transaction, including decimal points.\",\n \"9-2\": \"Credit card expiration month.\\n\\nAppears only in responses for Create and Retrieve Vaulted Shopper.\",\n \"10-0\": \"`expirationyear`\",\n \"10-1\": \"*integer*\",\n \"10-2\": \"Credit card expiration 4-digit year.\\n\\nAppears only in responses for Create and Retrieve Vaulted Shopper.\",\n \"2-2\": \"Card sub-type, such as `Credit` or `Debit`\",\n \"2-1\": \"*string*\",\n \"2-0\": \"`cardSubType`\",\n \"3-0\": \"`cardCategory`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Card category, such as business or prepaid.\\nAppears only if relevant.\",\n \"4-0\": \"`binCategory`\",\n \"4-1\": \"*string*\",\n \"4-2\": \"Indicates whether the card is used for business expenses (`Commercial`) or personal expenses (`Consumer`).\",\n \"5-0\": \"`binNumber`\",\n \"5-1\": \"*string*\",\n \"5-2\": \"The 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.\",\n \"6-0\": \"`cardRegulated`\",\n \"6-1\": \"*string*\",\n \"6-2\": \"Indicates whether the card is regulated. \\n\\nValues: \\n* **Y**\\n* **N**\",\n \"7-0\": \"`issuingBank`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"The bank that issued the shopper's card.\",\n \"8-0\": \"`issuingCountryCode`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"[Country code](/docs/country-codes) of the shopper's issuing bank.\"\n },\n \"cols\": 3,\n \"rows\": 11\n}\n[/block]","updates":[],"order":13,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"628531cd1258c8003f6dd1fa","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"628531cd1258c8003f6dd1ca","version":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.42 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["628531cd1258c8003f6dd1bf","628531cd1258c8003f6dd1c0","628531cd1258c8003f6dd1c1","628531cd1258c8003f6dd1c2","628531cd1258c8003f6dd1c3","628531cd1258c8003f6dd1c4","628531cd1258c8003f6dd1c5","628531cd1258c8003f6dd1c6","628531cd1258c8003f6dd1c7","628531cd1258c8003f6dd1c8","628531cd1258c8003f6dd1c9","628531cd1258c8003f6dd1ca","628531cd1258c8003f6dd1cb","628531cd1258c8003f6dd1cc","628531cd1258c8003f6dd1cd","628531cd1258c8003f6dd1ce","628531cd1258c8003f6dd1cf","628531cd1258c8003f6dd1d0","628531cd1258c8003f6dd1d1","628531cd1258c8003f6dd1d2"],"_id":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"622783372cd60c003782d77e","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-01-05T20:08:23.576Z","githubsync":"","__v":0}
creditCard
cardNumber
string
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
encryptedCardNumber
string
Required if cardNumber
is not sent.
Optional if sending a vaulted shopper ID.
Encrypted credit card number.
cardLastFourDigits
string
Optional
Required if sending a vaulted shopper ID and the shopper has multiple saved credit cards.
Last four digits of the credit card.
cardType
string
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
expirationMonth
integer
Required
Optional if sending a vaulted shopper ID.
Credit card expiration month.
expirationYear
integer
Required
Optional if sending a vaulted shopper ID.
Credit card expiration 4-digit year.
securityCode
string
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.
encryptedSecurityCode
string
Optional
Relevant if securityCode
is not sent.
N/A for batch transactions
Encrypted credit card security code.
securityCodePfToken
string
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.
cardLastFourDigits
string
Last four digits of the credit card.
cardType
string
Credit card type.
cardSubType
string
Card sub-type, such as Credit
or Debit
cardCategory
string
Card category, such as business or prepaid.
Appears only if relevant.
binCategory
string
Indicates whether the card is used for business expenses (Commercial
) or personal expenses (Consumer
).
binNumber
string
The 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.
cardRegulated
string
Indicates whether the card is regulated.
Values:
- Y
- N
issuingBank
string
The bank that issued the shopper's card.
expirationMonth
integer
Credit card expiration month.
Appears only in responses for Create and Retrieve Vaulted Shopper.
expirationyear
integer
Credit card expiration 4-digit year.
Appears only in responses for Create and Retrieve Vaulted Shopper.