{"_id":"5ab0f574ade4f4003cf6af8a","category":{"_id":"5ab0f55fade4f4003cf6af44","version":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-03-20T11:49:45.000Z","releaseDate":"2018-03-20T11:49:45.000Z","categories":["5ab0f55fade4f4003cf6af39","5ab0f55fade4f4003cf6af3a","5ab0f55fade4f4003cf6af3b","5ab0f55fade4f4003cf6af3c","5ab0f55fade4f4003cf6af3d","5ab0f55fade4f4003cf6af3e","5ab0f55fade4f4003cf6af3f","5ab0f55fade4f4003cf6af40","5ab0f55fade4f4003cf6af41","5ab0f55fade4f4003cf6af42","5ab0f55fade4f4003cf6af43","5ab0f55fade4f4003cf6af44","5ab0f55fade4f4003cf6af45","5ab0f55fade4f4003cf6af46","5ab0f55fade4f4003cf6af47"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-05T20:08:23.576Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"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    \"4-3\": \"Credit card expiration month.\",\n    \"5-3\": \"Credit card expiration 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    \"4-0\": \"`expirationMonth`\",\n    \"4-1\": \"*integer*\",\n    \"4-3\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"4-2\": \"Credit card expiration month.\\n\\nAppears only in responses for Create and Retrieve Vaulted Shopper.\",\n    \"5-0\": \"`expirationyear`\",\n    \"5-1\": \"*integer*\",\n    \"5-2\": \"Credit card expiration year.\\n\\nAppears only in responses for Create and Retrieve Vaulted Shopper.\",\n    \"6-0\": \"`issueNumber`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Issue number on the credit card.\",\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  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"Contains the details for a specific credit card, such as the card number and expiration date","slug":"credit-card","type":"basic","title":"creditCard"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

creditCard

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

Request

Property Name
Type
Required
Description

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.

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

Response

Property Name
Type
Description

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.

expirationMonth

integer

Credit card expiration month.

Appears only in responses for Create and Retrieve Vaulted Shopper.

expirationyear

integer

Credit card expiration year.

Appears only in responses for Create and Retrieve Vaulted Shopper.

issueNumber

string

Issue number on the credit card.