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. This should be the sum of the subtotal, tax (if applicable), and surcharge amount (if surcharging is enabled).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. |
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. |
cardTransactionType | string | Required | Defines the type of transaction. Possible values: AUTH_ONLY AUTH_CAPTURE CAPTURE AUTH_REVERSAL REFUND |
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. |
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. |
descriptorPhoneNumber | string | Optional | Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters. |
level3Data | object | Optional | Refer to the level3Data details. |
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. |
networkTransactionInfo | container | Optional | See networkTransactionInfo |
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. |
productDescription | string | Optional | The product description that will appear in IPNs, emails, and the Control Panel.Maximum 200 characters |
shippingContactInfo | object | Optional in AUTH_CAPTURE and AUTH_ONLY Not relevant for CAPTURE, AUTH_REVERSAL, or REFUND. | Details for the shipping contact. Refer to shippingContactInfo. |
softDescriptor | string | Optional | Description of the transaction that appears on the shopper's credit card statement.This property has the following restrictions:
|
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. |
surchargeInfo | object | Required if surcharging is enabled | If surcharging is enabled, you must provide this with all auth and/or capture requests even if the transaction was not eligible for surcharge. Refer to the surchargeInfo details. |
taxReference | string | Optional | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
threeDSecure | object | Optional | Refer to the threeDSecure details. |
transactionFraudInfo | object | Optional | Refer to the transactionFraudInfo details. |
transactionId | string | Required in CAPTURE Required in AUTH_REVERSAL and REFUND if not using merchantTransactionIdNot relevant for AUTH_ONLY and AUTH_CAPTURE | BlueSnap identifier for the transaction. |
transactionInitiator | string | Optional | Identifies who initiated the order. Options are:MERCHANT (for MIT)SHOPPER (for CIT)Refer to the 3-D Secure Guide. |
transactionMetaData | object | Optional | Refer to the transactionMetaData details. |
transactionOrderSource | string | Optional | Identifies the order type. The only option is MOTO (Mail Order Telephone Order). Any other option is ignored. |
updateShopperWithCardholderInfo | string | Optional | If this property is included with the value true, the following details will be updated based on the data in the cardHolderInfo object:
|
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. |
vendorsInfo | object | Optional Relevant for Marketplaces | Refer to the vendorsInfo details. |
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. |
walletId | long | Optional | ID of the wallet, obtained via the Create Wallet request. |
Response
| Property Name | Type | Description |
|---|---|---|
amount | decimal | Amount to be charged in the transaction, including decimal points. |
cardHolderInfo | object | See cardHolderInfo. |
cardTransactionType | string | Defines the type of transaction. Values can be: AUTH_ONLY AUTH_CAPTURE CAPTURE AUTH_REVERSAL REFUND |
chargebacks | object | See chargebacks. |
creditCard | object | See creditCard. |
currency | string | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
descriptorPhoneNumber | string | Merchant's support phone number that will appear on the shopper's credit card statement. |
fraudResultInfo | object | See fraudResultInfo. |
level3Data | object | See level3Data. |
merchantTransactionId | string | Merchant's unique ID for a new transaction. |
networkTransactionInfo | container | See networkTransactionInfo |
openToCapture | decimal | Remaining authorization amount available for capture. |
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. |
processingInfo | object | See processingInfo. |
refunds | object | See refunds. |
shippingContactInfo | object | See shippingContactInfo. |
softDescriptor | string | Description of the transaction, which appears on the customer's credit card statement. |
storeCard | boolean | Indicates if the shopper provided permissions to store their payment data. Possible values: true (default) Note: Not applicable when performing an Auth Only with an amount equal to zero. See Card on File Guide. |
taxReference | string | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
threeDSecure | object | See threeDSecure. |
transactionApprovalDate | string | The date the transaction was approved. |
transactionApprovalTime | string | The time the transaction was approved. This is in Pacific time. |
transactionId | string | BlueSnap identifier for the transaction. |
transactionMetaData | object | See transactionMetaData. |
vaultedShopperId | integer | ID of an existing vaulted shopper. |
vendorsInfo | object | See vendorsInfo. |
wallet | object | See wallet. |
