{"_id":"5c6c23e4735b81006177d03e","category":{"_id":"5c6c23e4735b81006177d011","version":"5c6c23e4735b81006177d0a4","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"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-15T19:23:06.210Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"10-0\": \"`cardTransactionType`\",\n    \"10-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"10-3\": \"Defines the type of transaction. \\nPossible values: \\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n    \"h-4\": \"Description\",\n    \"10-2\": \"**Required**\",\n    \"13-0\": \"`pfToken`\",\n    \"13-1\": \"*string*\",\n    \"13-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using [Hosted Payment Fields](/v8976-Tools/docs/hosted-payment-fields) or [Embedded Checkout](/v8976-Tools/docs/embedded-checkout)*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"13-3\": \"Hosted Payment Fields Fields or Embedded Checkout token.\",\n    \"12-0\": \"`transactionMetaData`\",\n    \"12-1\": \"*object*\",\n    \"12-2\": \"Optional\",\n    \"12-3\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n    \"1-0\": \"`amount`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"**Required** in AUTH_ONLY, AUTH_CAPTURE, and REFUND\\n\\nOptional in CAPTURE\\n\\nNot relevant for AUTH_REVERSAL\",\n    \"1-3\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"3-0\": \"`merchantTransactionId`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Merchant's unique ID for a new transaction. Between 1-50 characters.\",\n    \"4-0\": \"`softDescriptor`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.\",\n    \"6-0\": \"`cardHolderInfo`\",\n    \"6-1\": \"*object*\",\n    \"6-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if sending card data (including encrypted data) or `pfToken` and shopper is new*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"6-3\": \"See [cardHolderInfo](doc:card-holder-info).\",\n    \"7-0\": \"`currency`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"7-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"9-0\": \"`creditCard`\",\n    \"9-1\": \"*object*\",\n    \"9-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if sending card data or if `vaultedShopperId` is sent and the vaulted shopper has more than one credit card*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND.\",\n    \"9-3\": \"See [creditCard](doc:credit-card).\",\n    \"8-0\": \"`transactionFraudInfo`\",\n    \"8-1\": \"*object*\",\n    \"8-2\": \"Optional\",\n    \"8-3\": \"See [transactionFraudInfo](doc:transaction-fraud-info).\",\n    \"2-0\": \"`vaultedShopperId`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using a vaulted shopper*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"2-3\": \"ID of an existing vaulted shopper.\",\n    \"0-0\": \"`walletId`\",\n    \"0-1\": \"*long*\",\n    \"0-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using MasterPass or Visa Checkout*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"0-3\": \"ID of the wallet, obtained via the [Create Wallet](/v8976-Tools/docs/create-wallet) request.\",\n    \"14-0\": \"`transactionId`\",\n    \"14-1\": \"*string*\",\n    \"14-2\": \"**Required** in CAPTURE,  AUTH_REVERSAL, and REFUND\\n\\nNot relevant for AUTH_ONLY and AUTH_CAPTURE\",\n    \"14-3\": \"BlueSnap identifier for the transaction.\",\n    \"15-0\": \"`wallet`\",\n    \"15-1\": \"*object*\",\n    \"15-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using [Apple Pay](doc:apple-pay-guide) or [Google Pay](doc:google-pay)*\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n    \"15-3\": \"See [wallet](doc:wallet).\",\n    \"16-0\": \"`vendorsInfo`\",\n    \"16-1\": \"*object*\",\n    \"16-2\": \"*Relevant for Marketplaces*\\nOptional\",\n    \"16-3\": \"See [vendorsInfo](doc:vendorsinfo).\",\n    \"5-0\": \"`descriptorPhoneNumber`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Optional\",\n    \"5-3\": \"Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.\",\n    \"11-0\": \"`threeDSecure`\",\n    \"11-1\": \"*object*\",\n    \"11-2\": \"Optional\",\n    \"11-3\": \"See [threeDSecure](doc:threedsecure).\",\n    \"17-0\": \"`level3Data`\",\n    \"17-1\": \"*object*\",\n    \"17-2\": \"Optional\",\n    \"17-3\": \"See [level3Data](doc:level3data).\",\n    \"18-0\": \"`storeCard`\",\n    \"18-1\": \"*boolean*\",\n    \"18-2\": \"Optional\",\n    \"18-3\": \"Indicates whether or not to store the shopper's payment data.\\n\\nPossible values:\\n**true (default)\\nfalse**\\n\\n**Note:** Not applicable when performing an Auth Only with an amount equal to zero.\\n\\nSee [Card on File Guide](doc:card-on-file-guide).\"\n  },\n  \"cols\": 4,\n  \"rows\": 19\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    \"11-0\": \"`cardTransactionType`\",\n    \"11-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"11-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n    \"14-0\": \"`transactionId`\",\n    \"14-1\": \"*string*\",\n    \"14-3\": \"BlueSnap identifier for the transaction.\",\n    \"h-4\": \"Description\",\n    \"11-2\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n    \"14-2\": \"BlueSnap identifier for the transaction.\",\n    \"0-0\": \"`amount`\",\n    \"0-1\": \"*decimal*\",\n    \"0-2\": \"Amount to be charged in the transaction, including decimal points.\",\n    \"2-0\": \"`vaultedShopperId`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"ID of an existing vaulted shopper.\",\n    \"3-0\": \"`merchantTransactionId`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Merchant's unique ID for a new transaction.\",\n    \"4-0\": \"`processingInfo`\",\n    \"4-1\": \"*object*\",\n    \"4-2\": \"See [processingInfo](doc:processing-info).\",\n    \"5-0\": \"`softDescriptor`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Description of the transaction, which appears on the customer's credit card statement.\",\n    \"7-0\": \"`cardHolderInfo`\",\n    \"7-1\": \"*object*\",\n    \"7-2\": \"See [cardHolderInfo](doc:card-holder-info).\",\n    \"8-0\": \"`currency`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"10-0\": \"`creditCard`\",\n    \"10-1\": \"*object*\",\n    \"10-2\": \"See [creditCard](doc:credit-card).\",\n    \"13-0\": \"`transactionMetaData`\",\n    \"13-1\": \"*object*\",\n    \"13-2\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n    \"9-0\": \"`fraudResultInfo`\",\n    \"9-1\": \"*object*\",\n    \"9-2\": \"See [fraudResultInfo](doc:fraud-result-info).\",\n    \"16-2\": \"See [refunds](doc:refunds).\",\n    \"16-1\": \"*object*\",\n    \"16-0\": \"`refunds`\",\n    \"17-0\": \"`wallet`\",\n    \"17-1\": \"*object*\",\n    \"17-2\": \"See [wallet](doc:wallet).\",\n    \"6-0\": \"`descriptorPhoneNumber`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Merchant's support phone number that will appear on the shopper's credit card statement.\",\n    \"18-0\": \"`vendorsInfo`\",\n    \"18-1\": \"*object*\",\n    \"18-2\": \"See [vendorsInfo](doc:vendorsinfo).\",\n    \"15-0\": \"`chargebacks`\",\n    \"15-1\": \"*object*\",\n    \"15-2\": \"See [chargebacks](doc:chargebacks).\",\n    \"19-0\": \"`level3Data`\",\n    \"19-1\": \"*object*\",\n    \"19-2\": \"See [level3Data](doc:level3data).\",\n    \"12-0\": \"`threeDSecure`\",\n    \"12-1\": \"*object*\",\n    \"12-2\": \"See [threeDSecure](doc:threedsecure).\",\n    \"1-0\": \"`openToCapture`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"Remaining authorization amount available for capture.\",\n    \"20-2\": \"Indicates if the shopper provided permissions to store their payment data.\\n\\nPossible values:\\n**true (default)\\nfalse**\\n\\n**Note:** Not applicable when performing an Auth Only with an amount equal to zero.\\n\\nSee [Card on File Guide](doc:card-on-file-guide).\",\n    \"20-0\": \"`storeCard`\",\n    \"20-1\": \"*boolean*\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]","excerpt":"Contains the information required to process a credit card transaction","slug":"card-transaction","type":"basic","title":"cardTransaction"}