{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"cardTransaction","type":"basic","slug":"card-transaction","excerpt":"Contains the information required to process a credit card transaction","body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"11-0\": \"`cardTransactionType`\",\n \"11-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"11-3\": \"Defines the type of transaction. \\nPossible values: \\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n \"h-4\": \"Description\",\n \"11-2\": \"**Required**\",\n \"14-0\": \"`pfToken`\",\n \"14-1\": \"*string*\",\n \"14-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE *if using [Hosted Payment Fields](/v8976-Tools/docs/hosted-payment-fields), [Embedded Checkout](/v8976-Tools/docs/embedded-checkout), or [Secured Payment Collector](doc:secured-payment-collector) *\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n \"14-3\": \"Hosted Payment Fields, Embedded Checkout, or Secured Payment Collector token.\",\n \"13-0\": \"`transactionMetaData`\",\n \"13-1\": \"*object*\",\n \"13-2\": \"Optional\",\n \"13-3\": \"Refer to the [transactionMetaData](doc:transaction-meta-data) details.\",\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\\nThe maximum value can be up to `9999999999.99`, but please work with Merchant Support or your Implementation Specialist if you plan to send transactions over $50,000.\",\n \"3-0\": \"`merchantTransactionId`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Merchant's unique ID for a new transaction. 1–50 characters. Special characters are not recommended.\",\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 \"7-0\": \"`cardHolderInfo`\",\n \"7-1\": \"*object*\",\n \"7-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE for [LATAM local processing](doc:latam-local-processing)\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n \"7-3\": \"Refer to the [cardHolderInfo](doc:card-holder-info) details.\",\n \"8-0\": \"`currency`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"**Required** in AUTH_ONLY and AUTH_CAPTURE\\n\\nNot relevant for CAPTURE, AUTH_REVERSAL, and REFUND\",\n \"8-3\": \"Currency code (ISO 4217) of the amount to be charged. Refer to [Currency codes](/docs/currency-codes).\",\n \"10-0\": \"`creditCard`\",\n \"10-1\": \"*object*\",\n \"10-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 \"10-3\": \"Refer to the [creditCard](doc:credit-card) details.\",\n \"9-0\": \"`transactionFraudInfo`\",\n \"9-1\": \"*object*\",\n \"9-2\": \"Optional\",\n \"9-3\": \"Refer to the [transactionFraudInfo](doc:transaction-fraud-info) details.\",\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 \"15-0\": \"`transactionId`\",\n \"15-1\": \"*string*\",\n \"15-2\": \"**Required** in CAPTURE, AUTH_REVERSAL, and REFUND\\n\\nNot relevant for AUTH_ONLY and AUTH_CAPTURE\",\n \"15-3\": \"BlueSnap identifier for the transaction.\",\n \"16-0\": \"`wallet`\",\n \"16-1\": \"*object*\",\n \"16-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 \"16-3\": \"Refer to the [wallet](doc:wallet) details.\",\n \"17-0\": \"`vendorsInfo`\",\n \"17-1\": \"*object*\",\n \"17-2\": \"*Relevant for Marketplaces*\\nOptional\",\n \"17-3\": \"Refer to the [vendorsInfo](doc:vendorsinfo) details.\",\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 \"12-0\": \"`threeDSecure`\",\n \"12-1\": \"*object*\",\n \"12-2\": \"Optional\",\n \"12-3\": \"Refer to the [threeDSecure](doc:threedsecure) details.\",\n \"18-0\": \"`level3Data`\",\n \"18-1\": \"*object*\",\n \"18-2\": \"Optional\",\n \"18-3\": \"Refer to the [level3Data](doc:level3data) details.\",\n \"19-0\": \"`storeCard`\",\n \"19-1\": \"*boolean*\",\n \"19-2\": \"Optional\",\n \"19-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\\nRefer to the [Card on File Guide](doc:card-on-file-guide).\",\n \"20-0\": \"`transactionOrderSource`\",\n \"20-1\": \"*string*\",\n \"20-2\": \"Optional\",\n \"20-3\": \"Identifies the order type.<br />The only option is `MOTO` (**M**ail **O**rder **T**elephone **O**rder). <br />Any other option is ignored.\",\n \"21-0\": \"`transactionInitiator`\",\n \"21-1\": \"*string*\",\n \"21-2\": \"Optional\",\n \"21-3\": \"Identifies who initiated the order. Options are:\\n`MERCHANT` (for MIT)\\n`SHOPPER` (for CIT)\\n\\nRefer to the [3-D Secure Guide](https://support.bluesnap.com/docs/3d-secure).\",\n \"22-0\": \"`networkTransactionInfo`\",\n \"22-1\": \"*container*\",\n \"22-2\": \"Optional\",\n \"22-3\": \"See [networkTransactionInfo](doc:network-transaction-info)\",\n \"6-0\": \"`taxReference`\",\n \"6-1\": \"*string*\",\n \"6-2\": \"Optional\",\n \"6-3\": \"Unique ID for the tax quote. Refer to the [Taxes guide](https://developers.bluesnap.com/v8976-Basics/docs/taxes) for further details.\"\n },\n \"cols\": 4,\n \"rows\": 23\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 \"14-0\": \"`cardTransactionType`\",\n \"14-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"14-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"17-0\": \"`transactionId`\",\n \"17-1\": \"*string*\",\n \"17-3\": \"BlueSnap identifier for the transaction.\",\n \"h-4\": \"Description\",\n \"14-2\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nREFUND\",\n \"17-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 \"8-0\": \"`cardHolderInfo`\",\n \"8-1\": \"*object*\",\n \"8-2\": \"See [cardHolderInfo](doc:card-holder-info).\",\n \"9-0\": \"`currency`\",\n \"9-1\": \"*string*\",\n \"9-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n \"13-0\": \"`creditCard`\",\n \"13-1\": \"*object*\",\n \"13-2\": \"See [creditCard](doc:credit-card).\",\n \"16-0\": \"`transactionMetaData`\",\n \"16-1\": \"*object*\",\n \"16-2\": \"See [transactionMetaData](doc:transaction-meta-data).\",\n \"12-0\": \"`fraudResultInfo`\",\n \"12-1\": \"*object*\",\n \"12-2\": \"See [fraudResultInfo](doc:fraud-result-info).\",\n \"20-2\": \"See [refunds](doc:refunds).\",\n \"20-1\": \"*object*\",\n \"20-0\": \"`refunds`\",\n \"21-0\": \"`wallet`\",\n \"21-1\": \"*object*\",\n \"21-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 \"22-0\": \"`vendorsInfo`\",\n \"22-1\": \"*object*\",\n \"22-2\": \"See [vendorsInfo](doc:vendorsinfo).\",\n \"19-0\": \"`chargebacks`\",\n \"19-1\": \"*object*\",\n \"19-2\": \"See [chargebacks](doc:chargebacks).\",\n \"23-0\": \"`level3Data`\",\n \"23-1\": \"*object*\",\n \"23-2\": \"See [level3Data](doc:level3data).\",\n \"15-0\": \"`threeDSecure`\",\n \"15-1\": \"*object*\",\n \"15-2\": \"See [threeDSecure](doc:threedsecure).\",\n \"1-0\": \"`openToCapture`\",\n \"1-1\": \"*decimal*\",\n \"1-2\": \"Remaining authorization amount available for capture.\",\n \"24-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 \"24-0\": \"`storeCard`\",\n \"24-1\": \"*boolean*\",\n \"25-0\": \"`networkTransactionInfo`\",\n \"25-1\": \"*container*\",\n \"25-2\": \"See [networkTransactionInfo](doc:network-transaction-info)\",\n \"10-0\": \"`transactionApprovalDate`\",\n \"11-0\": \"`transactionApprovalTime`\",\n \"10-1\": \"*string*\",\n \"10-2\": \"The date the transaction was approved.\",\n \"11-1\": \"*string*\",\n \"11-2\": \"The time the transaction was approved. This is in Pacific time.\",\n \"18-0\": \"`originalTransactionId`\",\n \"18-1\": \"*string*\",\n \"18-2\": \"Present in the Retrieve Card Transaction response if the transaction was retrieved by the refund transaction ID. The value is the transaction ID of the original transaction.\",\n \"7-0\": \"`taxReference`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Unique ID for the tax quote. Refer to the [Taxes guide](https://developers.bluesnap.com/v8976-Basics/docs/taxes) for further details.\"\n },\n \"cols\": 3,\n \"rows\": 26\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603d5bd1309e0703644e92ff","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603d5bd1309e0703644e9266","603d5bd1309e0703644e9267","603d5bd1309e0703644e9268","603d5bd1309e0703644e9269","603d5bd1309e0703644e926a","603d5bd1309e0703644e926b","603d5bd1309e0703644e926c","603d5bd1309e0703644e926d","603d5bd1309e0703644e926e","603d5bd1309e0703644e926f","603d5bd1309e0703644e9270","603d5bd1309e0703644e9271","603d5bd1309e0703644e9272","603d5bd1309e0703644e9273","603d5bd1309e0703644e9274","603d5bd1309e0703644e9275","603d5bd1309e0703644e9276","603d5bd1309e0703644e9277","603d5bd1309e0703644e9278"],"_id":"603d5bd1309e0703644e931e","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5ff39c12e2e8fa00503ad5e4","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":15,"from_sync":false,"reference":false,"_id":"603d5bd1309e0703644e9271","version":"603d5bd1309e0703644e931e","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-07-18T15:09:10.082Z","__v":0,"parentDoc":null}cardTransaction
walletId
long
Required in AUTH_ONLY and AUTH_CAPTURE if using MasterPass or Visa Checkout
Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
ID of the wallet, obtained via the Create Wallet request.
amount
decimal
Required in AUTH_ONLY, AUTH_CAPTURE, and REFUND
Optional in CAPTURE
Not relevant for AUTH_REVERSAL
Amount to be charged in the transaction, including decimal points.
The maximum value can be up to 9999999999.99, but please work with Merchant Support or your Implementation Specialist if you plan to send transactions over $50,000.
vaultedShopperId
integer
Required in AUTH_ONLY and AUTH_CAPTURE if using a vaulted shopper
Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
ID of an existing vaulted shopper.
merchantTransactionId
string
Optional
Merchant's unique ID for a new transaction. 1–50 characters. Special characters are not recommended.
softDescriptor
string
Optional
Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
descriptorPhoneNumber
string
Optional
Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.
taxReference
string
Optional
Unique ID for the tax quote. Refer to the Taxes guide for further details.
cardHolderInfo
object
Required in AUTH_ONLY and AUTH_CAPTURE for LATAM local processing
Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Refer to the cardHolderInfo details.
currency
string
Required in AUTH_ONLY and AUTH_CAPTURE
Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Currency code (ISO 4217) of the amount to be charged. Refer to Currency codes.
creditCard
object
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
Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND.
Refer to the creditCard details.
cardTransactionType
string
Required
Defines the type of transaction.
Possible values:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND
pfToken
string
Required in AUTH_ONLY and AUTH_CAPTURE if using Hosted Payment Fields, Embedded Checkout, or Secured Payment Collector
Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Hosted Payment Fields, Embedded Checkout, or Secured Payment Collector token.
transactionId
string
Required in CAPTURE, AUTH_REVERSAL, and REFUND
Not relevant for AUTH_ONLY and AUTH_CAPTURE
BlueSnap identifier for the transaction.
wallet
object
Required in AUTH_ONLY and AUTH_CAPTURE if using Apple Pay or Google Pay
Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Refer to the wallet details.
storeCard
boolean
Optional
Indicates whether or not to store the shopper's payment data.
Possible values:
true (default)
false
Note: Not applicable when performing an Auth Only with an amount equal to zero.
Refer to the Card on File Guide.
transactionOrderSource
string
Optional
Identifies the order type.
The only option is MOTO (Mail Order Telephone Order).
Any other option is ignored.
transactionInitiator
string
Optional
Identifies who initiated the order. Options are:MERCHANT (for MIT)SHOPPER (for CIT)
Refer to the 3-D Secure Guide.
amount
decimal
Amount to be charged in the transaction, including decimal points.
openToCapture
decimal
Remaining authorization amount available for capture.
vaultedShopperId
integer
ID of an existing vaulted shopper.
merchantTransactionId
string
Merchant's unique ID for a new transaction.
softDescriptor
string
Description of the transaction, which appears on the customer's credit card statement.
descriptorPhoneNumber
string
Merchant's support phone number that will appear on the shopper's credit card statement.
transactionApprovalDate
string
The date the transaction was approved.
transactionApprovalTime
string
The time the transaction was approved. This is in Pacific time.
cardTransactionType
string
Defines the type of transaction. Values can be:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND
transactionId
string
BlueSnap identifier for the transaction.
originalTransactionId
string
Present in the Retrieve Card Transaction response if the transaction was retrieved by the refund transaction ID. The value is the transaction ID of the original transaction.
storeCard
boolean
Indicates if the shopper provided permissions to store their payment data.
Possible values:
true (default)
false
Note: Not applicable when performing an Auth Only with an amount equal to zero.
See Card on File Guide.
