{"_id":"59a45d467ee621000fc9d415","category":{"_id":"59a45d447ee621000fc9d3c4","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__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":58,"body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`card-number`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Credit card number.\\nFor example:\\n * 4111111111111111\\n * 4111-1111-1111-1111\\n * 4111 1111 1111 1111\",\n \"1-0\": \"`encrypted-card-number`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"Encrypted credit card number.\",\n \"h-4\": \"Description\",\n \"0-2\": \"**Required** if `encrypted-card-number` is not sent.\\n\\nOptional if sending a `vaulted-shopper-id`.\",\n \"1-2\": \"**Required** if `card-number` is not sent.\\n\\nOptional if sending a `vaulted-shopper-id`.\",\n \"2-0\": \"`card-last-four-digits`\",\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 vaulted shopper has multiple saved credit cards.\",\n \"3-0\": \"`card-type`\",\n \"4-0\": \"`expiration-month`\",\n \"5-0\": \"`expiration-year`\",\n \"6-0\": \"`security-code`\",\n \"7-0\": \"`encrypted-security-code`\",\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 `card-number` or `encrypted-card-number`.\\n\\n**Note**: If you do not send the `card-type`, BlueSnap will automatically identify the type based on the number. If you do send a card type but BlueSnap identifies that the card is a different type, the transaction will fail. You can check the card type for a specific number using the [Retrieve Card Info](/v4.0/docs/retrieve-card-info) request.\\n\\n**Required** if sending a `vaulted-shopper-id` and `card-last-four-digits`\",\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 `encrypted-security-code` is not sent. \\n\\nN/A for batch transactions\",\n \"7-2\": \"Optional\\n\\nRelevant if `security-code` 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.\",\n \"7-3\": \"Encrypted credit card security code.\",\n \"8-0\": \"`security-code-pf-token`\",\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\": \"`card-last-four-digits`\",\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\": \"`card-type`\",\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\": \"`expiration-month`\",\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\": \"`expiration-year`\",\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\": \"`issue-number`\",\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\": \"`card-sub-type`\",\n \"3-0\": \"`card-category`\",\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":"credit-card"}credit-card
card-number
string
Required if encrypted-card-number is not sent.
Optional if sending a vaulted-shopper-id.
Credit card number.
For example:
- 4111111111111111
- 4111-1111-1111-1111
- 4111 1111 1111 1111
encrypted-card-number
string
Required if card-number is not sent.
Optional if sending a vaulted-shopper-id.
Encrypted credit card number.
card-last-four-digits
string
Optional
Required if sending a vaulted-shopper-id and the vaulted shopper has multiple saved credit cards.
Last four digits of the credit card.
card-type
string
Optional if sending card-number or encrypted-card-number.
Note: If you do not send the card-type, BlueSnap will automatically identify the type based on the number. If you do send a card type but BlueSnap identifies that the card is a different type, the transaction will fail. You can check the card type for a specific number using the Retrieve Card Info request.
Required if sending a vaulted-shopper-id and card-last-four-digits
Credit card type.
expiration-month
integer
Required
Optional if sending a vaulted-shopper-id
Credit card expiration month.
expiration-year
integer
Required
Optional if sending a vaulted-shopper-id
Credit card expiration year.
security-code
string
Optional
Relevant if encrypted-security-code is not sent.
N/A for batch transactions
Credit card security code.
encrypted-security-code
string
Optional
Relevant if security-code is not sent.
N/A for batch transactions
Encrypted credit card security code.
security-code-pf-token
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.
card-last-four-digits
string
Last four digits of the credit card.
card-type
string
Credit card type.
card-sub-type
string
Card sub-type, such as Credit or Debit
card-category
string
Card category, such as business or prepaid.
Appears only if relevant.
expiration-month
integer
Credit card expiration month.
Appears only in responses for Create and Retrieve Vaulted Shopper.
expiration-year
integer
Credit card expiration year.
Appears only in responses for Create and Retrieve Vaulted Shopper.
issue-number
string
Issue number on the credit card.