cardTransaction

Contains the information required to process a credit card transaction

Request

Property NameTypeRequiredDescription
walletIdlongRequired in AUTHONLY and AUTH_CAPTURE _if using Visa Checkout

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
ID of the wallet, obtained via the Create Wallet request.
amountdecimalRequired 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.
vaultedShopperIdintegerRequired in AUTHONLY and AUTH_CAPTURE _if using a vaulted shopper

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
ID of an existing vaulted shopper.
updateShopperWithCardholderInfostringOptionalIf this property is included with the value true, the following details will be updated based on the data in the cardHolderInfo object:
- Shopper details
- Invoice contact information
- Credit card information

Default value is false.
merchantTransactionIdstringOptional

Required in AUTH_REVERSAL and REFUND if not using transactionId
Merchant's unique ID for a new transaction. 1–50 characters. Special characters are not recommended.
softDescriptorstringOptionalDescription of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
descriptorPhoneNumberstringOptionalMerchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.
taxReferencestringOptionalUnique ID for the tax quote. Refer to the Taxes guide for further details.
cardHolderInfoobjectRequired in AUTH_ONLY and AUTH_CAPTURE for LATAM local processing

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Refer to the cardHolderInfo details.
currencystringRequired 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.
transactionFraudInfoobjectOptionalRefer to the transactionFraudInfo details.
creditCardobjectRequired in AUTHONLY 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.
cardTransactionTypestringRequiredDefines the type of transaction.
Possible values:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND
threeDSecureobjectOptionalRefer to the threeDSecure details.
transactionMetaDataobjectOptionalRefer to the transactionMetaData details.
pfTokenstringRequired in AUTHONLY and AUTH_CAPTURE _if using Hosted Payment Fields or Secured Payment Collector

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Hosted Payment Fields or Secured Payment Collector token.
transactionIdstringRequired in CAPTURE

Required in AUTH_REVERSAL and REFUND if not using merchantTransactionId

Not relevant for AUTH_ONLY and AUTH_CAPTURE
BlueSnap identifier for the transaction.
walletobjectRequired in AUTHONLY and AUTH_CAPTURE _if using Apple Pay or Google Pay

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Refer to the wallet details.
vendorsInfoobjectRelevant for Marketplaces
Optional
Refer to the vendorsInfo details.
level3DataobjectOptionalRefer to the level3Data details.
storeCardbooleanOptionalIndicates 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.
transactionOrderSourcestringOptionalIdentifies the order type.
The only option is MOTO  (Mail Order Telephone Order).
Any other option is ignored.
transactionInitiatorstringOptionalIdentifies who initiated the order. Options are:
MERCHANT (for MIT)
SHOPPER (for CIT)

Refer to the 3-D Secure Guide.
networkTransactionInfocontainerOptionalSee networkTransactionInfo
productDescriptionstringOptionalThe product description that will appear in IPNs, emails, and the Control Panel.

Response

Property NameTypeDescription
amountdecimalAmount to be charged in the transaction, including decimal points.
openToCapturedecimalRemaining authorization amount available for capture.
vaultedShopperIdintegerID of an existing vaulted shopper.
merchantTransactionIdstringMerchant's unique ID for a new transaction.
processingInfoobjectSee processingInfo.
softDescriptorstringDescription of the transaction, which appears on the customer's credit card statement.
descriptorPhoneNumberstringMerchant's support phone number that will appear on the shopper's credit card statement.
taxReferencestringUnique ID for the tax quote. Refer to the Taxes guide for further details.
cardHolderInfoobjectSee cardHolderInfo.
currencystringCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
transactionApprovalDatestringThe date the transaction was approved.
transactionApprovalTimestringThe time the transaction was approved. This is in Pacific time.
fraudResultInfoobjectSee fraudResultInfo.
creditCardobjectSee creditCard.
cardTransactionTypestringDefines the type of transaction. Values can be:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND
threeDSecureobjectSee threeDSecure.
transactionMetaDataobjectSee transactionMetaData.
transactionIdstringBlueSnap identifier for the transaction.
originalTransactionIdstringPresent 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.
chargebacksobjectSee chargebacks.
refundsobjectSee refunds.
walletobjectSee wallet.
vendorsInfoobjectSee vendorsInfo.
level3DataobjectSee level3Data.
storeCardbooleanIndicates 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.
networkTransactionInfocontainerSee networkTransactionInfo