card-transaction

Contains the information required to process a credit card transaction

Request

Property NameTypeRequiredDescription
card-transaction-typestringRequiredDefines the type of transaction. Values can be:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND
transaction-idstringRequired in CAPTURE

Required in AUTH_REVERSAL and REFUND if not using merchant-transaction-id

Not relevant for AUTH_ONLY and AUTH_CAPTURE
BlueSnap identifier for the transaction.
merchant-transaction-idstringOptional

Required in AUTH_REVERSAL and REFUND if not using transaction-id
Merchant's unique ID for a new transaction. Between 1 - 50 characters. Special characters are not recommended.
soft-descriptorstringOptionalDescription of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.
descriptor-phone-numberstringOptionalMerchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.
tax-referencestringOptionalUnique ID for the tax quote. Refer to the Taxes guide for further details.
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.
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. See Currency codes.
vaulted-shopper-idintegerRequired in AUTHONLY and AUTH_CAPTURE _if using a vaulted shopper

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

Default value is false.
card-holder-infocontainerRequired in AUTH_ONLY and AUTH_CAPTURE for LATAM local processing

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Container of card-holder-info properties.
wallet-idlongRequired 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.
transaction-fraud-infocontainerOptionalContainer of transaction-fraud-info properties.
credit-cardcontainerRequired in AUTHONLY and AUTH_CAPTURE _if sending card data or if vaulted-shopper-id is sent and the vaulted shopper has more than one credit card

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
Container of credit-card properties.
pf-tokenstringRequired 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.
three-d-securecontainerOptionalContainer of three-d-secure properties.
transaction-meta-datacontainerOptionalContainer of transaction-meta-data properties.
walletcontainerRequired in AUTHONLY and AUTH_CAPTURE _if using Apple Pay or Google Pay™

Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND
See wallet.
vendors-infocontainerRelevant for Marketplaces
Optional
Container of vendors-info properties.
level-3-datacontainerOptionalContainer of level-3-data properties.
store-cardbooleanOptionalIndicates 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.

See Card on File Guide.
transaction-order-sourcestringOptionalIdentifies the order type.
The only option is MOTO  (Mail Order Telephone Order).
Any other option is ignored.
transaction-initiatorstringOptionalIdentifies who initiated the order. Options are:
MERCHANT (for MIT)
SHOPPER (for CIT)

Refer to the 3-D Secure Guide.
network-transaction-infocontainerOptionalSee network-transaction-info
product-descriptionstringOptionalThe product description that will appear in IPNs, emails, and the Control Panel.

Response

Property NameTypeDescription
card-transaction-typestringDefines the type of transaction. Values can be:
AUTH_ONLY
AUTH_CAPTURE
CAPTURE
AUTH_REVERSAL
REFUND
transaction-idstringBlueSnap identifier for the transaction.
original-transaction-idstringPresent 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.
merchant-transaction-idstringMerchant's unique ID for a new transaction. Between 1 - 50 characters.
soft-descriptorstringDescription of the transaction, which appears on the customer's credit card statement.
descriptor-phone-numberstringMerchant's support phone number that will appear on the shopper's credit card statement.
tax-referencestringUnique ID for the tax quote. Refer to the Taxes guide for further details.
amountdecimalAmount to be charged in the transaction, including decimal points.
currencystringCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
transaction-approval-datestringThe date the transaction was approved.
transaction-approval-timestringThe time the transaction was approved. This is in Pacific time.
open-to-capturedecimalRemaining authorization amount available for capture.
vaulted-shopper-idintegerID of an existing vaulted shopper.
card-holder-infocontainerContainer of card-holder-info properties.
credit-cardcontainerContainer of credit-card properties.
three-d-securecontainerContainer of three-d-secure properties.
transaction-meta-datacontainerContainer of transaction-meta-data properties.
processing-infocontainerContainer of processing-info properties.
fraud-result-infocontainerContainer of fraud-result-info properties.
chargebackscontainerContainer of chargebacks properties.
refundscontainerContainer of refunds properties.
walletcontainerContainer of Apple Pay or Google Pay wallet properties.
vendors-infocontainerContainer of vendors-info properties.
level-3-datacontainerContainer of level-3-data properties.
store-cardbooleanIndicates 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.
network-transaction-infocontainerSee network-transaction-info