Contains the information required to process a credit card transaction
Request
Property Name | Type | Required | Description |
|---|---|---|---|
| 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 |
| 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. |
| string | Required | Defines the type of transaction. Values can be: AUTH_ONLY, AUTH_CAPTURE, CAPTURE, AUTH_REVERSAL, or REFUND |
| container | Required in AUTH_ONLY and AUTH_CAPTURE if sending card data or if Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND | Container of credit-card properties. |
| 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. |
| string | Optional | Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters. |
| container | Optional | Container of level-3-data properties. |
| string | Optional Required in AUTH_REVERSAL and REFUND if not using | Merchant's unique ID for a new transaction. Between 1 - 50 characters. Special characters are not recommended. |
| container | Optional | |
| 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. |
| string | Optional | The product description that will appear in IPNs, emails, and the Control Panel. |
| string | Optional | Description of the transaction that appears on the shopper's credit card statement. This property has the following restrictions:
|
| boolean | Optional | Indicates whether or not to store the shopper's payment data. Possible values: Note: Not applicable when performing an Auth Only with an amount equal to zero. |
| string | Optional | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
| container | Optional | Container of three-d-secure properties. |
| container | Optional | Container of transaction-fraud-info properties. |
| string | Requiredin CAPTURE Not relevant for AUTH_ONLY and AUTH_CAPTURE | BlueSnap identifier for the transaction. |
| string | Optional | Identifies who initiated the order. Options are: |
| container | Optional | Container of transaction-meta-data properties. |
| string | Optional | Identifies the order type. The only option is |
| 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. |
| container | Relevant for Marketplaces Optional | Container of vendors-info properties. |
| 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. |
| 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. |
| string | Optional | If this property is included with the value
|
Response
Property Name | Type | Description |
|---|---|---|
| decimal | Amount to be charged in the transaction, including decimal points. |
| container | Container of card-holder-info properties. |
| string | Defines the type of transaction. Values can be: AUTH_ONLY, AUTH_CAPTURE, CAPTURE, AUTH_REVERSAL, or REFUND |
| container | Container of chargebacks properties. |
| container | Container of credit-card properties. |
| string | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
| string | Merchant's support phone number that will appear on the shopper's credit card statement. |
| container | Container of fraud-result-info properties. |
| container | Container of level-3-data properties. |
| string | Merchant's unique ID for a new transaction. Between 1 - 50 characters. |
| container | |
| decimal | Remaining authorization amount available for capture. |
| 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. |
| container | Container of processing-info properties. |
| container | Container of refunds properties. |
| string | Description of the transaction, which appears on the customer's credit card statement. |
| boolean | Indicates if the shopper provided permissions to store their payment data. Possible values: Note: Not applicable when performing an Auth Only with an amount equal to zero. |
| string | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
| container | Container of three-d-secure properties. |
| string | The date the transaction was approved. |
| string | The time the transaction was approved. This is in Pacific time. |
| string | BlueSnap identifier for the transaction. |
| container | Container of transaction-meta-data properties. |
| integer | ID of an existing vaulted shopper. |
| container | Container of vendors-info properties. |
| container | Container of Apple Pay or Google Pay wallet properties. |