cardTransaction

Contains the information required to process a credit card transaction

Request

Property Name

Type

Required

Description

walletId

long

Required in AUTH_ONLY 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.

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

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.

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.

transactionFraudInfo

object

Optional

Refer to the transactionFraudInfo details.

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

threeDSecure

object

Optional

Refer to the threeDSecure details.

transactionMetaData

object

Optional

Refer to the transactionMetaData details.

pfToken

string

Required in AUTH_ONLY 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.

transactionId

string

Required 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.

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.

vendorsInfo

object

Relevant for Marketplaces Optional

Refer to the vendorsInfo details.

level3Data

object

Optional

Refer to the level3Data 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.

networkTransactionInfo

container

Optional

See networkTransactionInfo

Response

Property Name

Type

Description

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.

processingInfo

object

See processingInfo.

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.

taxReference

string

Unique ID for the tax quote. Refer to the Taxes guide for further details.

cardHolderInfo

object

See cardHolderInfo.

currency

string

Currency code (ISO 4217) of the amount to be charged. See Currency codes.

transactionApprovalDate

string

The date the transaction was approved.

transactionApprovalTime

string

The time the transaction was approved. This is in Pacific time.

fraudResultInfo

object

See fraudResultInfo.

creditCard

object

See creditCard.

cardTransactionType

string

Defines the type of transaction. Values can be: AUTH_ONLY AUTH_CAPTURE CAPTURE AUTH_REVERSAL REFUND

threeDSecure

object

See threeDSecure.

transactionMetaData

object

See transactionMetaData.

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.

chargebacks

object

See chargebacks.

refunds

object

See refunds.

wallet

object

See wallet.

vendorsInfo

object

See vendorsInfo.

level3Data

object

See level3Data.

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.

networkTransactionInfo

container

See networkTransactionInfo