{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"credit-card","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\": \"`card-number`\",\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\": \"`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](/v8976-Tools/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\\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\": \"`security-code-pf-token`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Optional \\n\\nRelevant if using [Hosted Payment Fields](/v8976-Tools/docs/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    \"9-0\": \"`expiration-month`\",\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\": \"`expiration-year`\",\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\": \"`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    \"4-2\": \"Indicates whether the card is used for business expenses (`Commercial`) or personal expenses (`Consumer`).\",\n    \"4-1\": \"*string*\",\n    \"4-0\": \"`bin-category`\",\n    \"5-0\": \"`bin-number`\",\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\": \"`card-regulated`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Indicates whether the card is regulated. \\n\\nValues: \\n* **Y**\\n* **N**\",\n    \"7-0\": \"`issuing-bank`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"The bank that issued the shopper's card.\",\n    \"8-0\": \"`issuing-country-code`\",\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":"61a5208deadb750070998eaa","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"61a5208deadb750070998e93","version":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5208deadb750070998e87","61a5208deadb750070998e88","61a5208deadb750070998e89","61a5208deadb750070998e8a","61a5208deadb750070998e8b","61a5208deadb750070998e8c","61a5208deadb750070998e8d","61a5208deadb750070998e8e","61a5208deadb750070998e8f","61a5208deadb750070998e90","61a5208deadb750070998e91","61a5208deadb750070998e92","61a5208deadb750070998e93","61a5208deadb750070998e94","61a5208deadb750070998e95","61a5208deadb750070998e96","61a5208deadb750070998e97","61a5208deadb750070998e98","61a5208deadb750070998e99","61a5208deadb750070998e9a"],"_id":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed269718a45001c25b4a0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-01-05T20:08:23.576Z","githubsync":"","__v":0}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

credit-card

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

Request

Property Name
Type
Required
Description

card-number

string

Required if encrypted-card-number 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

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.

Possible Values:

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

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 4-digit year.

security-code

string

Optional

Relevant if encrypted-security-code 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.

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.

Response

Property Name
Type
Description

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.

bin-category

string

Indicates whether the card is used for business expenses (Commercial) or personal expenses (Consumer).

bin-number

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.

card-regulated

string

Indicates whether the card is regulated.

Values:

  • Y
  • N

issuing-bank

string

The bank that issued the shopper's card.

issuing-country-code

string

Country code of the shopper's issuing bank.

expiration-month

integer

Credit card expiration month.

Appears only in responses for Create and Retrieve Vaulted Shopper.

expiration-year

integer

Credit card expiration 4-digit year.

Appears only in responses for Create and Retrieve Vaulted Shopper.