card-transaction

Contains the information required to process a credit card transaction

Request

Property Name

Type

Required

Description

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.

card-holder-info

container

  • *Required** in AUTH_ONLY and AUTH_CAPTURE for LATAM local processing

    Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

Container of card-holder-info properties.

card-transaction-type

string

Required

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

credit-card

container

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

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. See Currency codes.

descriptor-phone-number

string

Optional

Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters.

level-3-data

container

Optional

Container of level-3-data properties.

merchant-transaction-id

string

Optional

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.

network-transaction-info

container

Optional

See network-transaction-info

pf-token

string

Hosted Payment Fields or Secured Payment Collector token.

product-description

string

Optional

The product description that will appear in IPNs, emails, and the Control Panel.

soft-descriptor

string

Optional

Description of the transaction that appears on the shopper's credit card statement.

This property has the following restrictions:

  • ASCII characters only
  • Maximum 20 characters

store-card

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.

See Card on File Guide.

tax-reference

string

Optional

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

three-d-secure

container

Optional

Container of three-d-secure properties.

transaction-fraud-info

container

Optional

Container of transaction-fraud-info properties.

transaction-id

string

  • *Requiredin 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.

transaction-initiator

string

Optional

Identifies who initiated the order. Options are:
MERCHANT (for MIT)
SHOPPER (for CIT)

Refer to the 3-D Secure Guide.

transaction-meta-data

container

Optional

Container of transaction-meta-data properties.

transaction-order-source

string

Optional

Identifies the order type.
The only option is MOTO (Mail Order Telephone Order).
Any other option is ignored.

vaulted-shopper-id

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.

vendors-info

container

  • Relevant for Marketplaces_
    Optional

Container of vendors-info properties.

wallet

container

  • *Required** in AUTH_ONLY and AUTH_CAPTURE
    if using Apple Pay or Google Pay™

    Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND

See wallet.

wallet-id

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.

update-shopper-with-card-holder-info

string

Optional

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


Response

Property NameTypeDescription
amountdecimalAmount to be charged in the transaction, including decimal points.
card-holder-infocontainerContainer of card-holder-info properties.
card-transaction-typestringDefines the type of transaction. Values can be: \nAUTH_ONLY \nAUTH_CAPTURE \nCAPTURE \nAUTH_REVERSAL \nREFUND
chargebackscontainerContainer of chargebacks properties.
credit-cardcontainerContainer of credit-card properties.
currencystringCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
descriptor-phone-numberstringMerchant's support phone number that will appear on the shopper's credit card statement.
fraud-result-infocontainerContainer of fraud-result-info properties.
level-3-datacontainerContainer of level-3-data properties.
merchant-transaction-idstringMerchant's unique ID for a new transaction. Between 1 - 50 characters.
network-transaction-infocontainerSee network-transaction-info
open-to-capturedecimalRemaining authorization amount available for capture.
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.
processing-infocontainerContainer of processing-info properties.
refundscontainerContainer of refunds properties.
soft-descriptorstringDescription of the transaction, which appears on the customer's credit card statement.
store-cardbooleanIndicates if the shopper provided permissions to store their payment data. \n \nPossible values: \ntrue (default)\nfalse \n \nNote: Not applicable when performing an Auth Only with an amount equal to zero. \n \nSee Card on File Guide.
tax-referencestringUnique ID for the tax quote. Refer to the Taxes guide for further details.
three-d-securecontainerContainer of three-d-secure properties.
transaction-approval-datestringThe date the transaction was approved.
transaction-approval-timestringThe time the transaction was approved. This is in Pacific time.
transaction-idstringBlueSnap identifier for the transaction.
transaction-meta-datacontainerContainer of transaction-meta-data properties.
vaulted-shopper-idintegerID of an existing vaulted shopper.
vendors-infocontainerContainer of vendors-info properties.
walletcontainerContainer of Apple Pay or Google Pay wallet properties.