Contains the information required to process a credit card transaction
Request
| Property Name | Type | Required | Description |
|---|---|---|---|
card-transaction-type | string | Required | Defines the type of transaction. Values can be: AUTH_ONLY AUTH_CAPTURE CAPTURE AUTH_REVERSAL REFUND |
transaction-id | string |
| BlueSnap identifier for the transaction. |
merchant-transaction-id | string | Optional
| Merchant's unique ID for a new transaction. Between 1 - 50 characters. Special characters are not recommended. |
soft-descriptor | string | Optional | Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters. |
descriptor-phone-number | string | Optional | Merchant's support phone number that will appear on the shopper's credit card statement. Maximum 20 characters. |
tax-reference | string | Optional | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
amount | decimal |
Not relevant for AUTH_REVERSAL | Amount to be charged in the transaction, including decimal points. The maximum value can be up to |
currency | string |
| Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
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. |
card-holder-info | container |
| Container of card-holder-info properties. |
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. |
transaction-fraud-info | container | Optional | Container of transaction-fraud-info properties. |
credit-card | 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. |
pf-token | string | Required in AUTH_ONLY and AUTH_CAPTURE if usingHosted Payment Fields or Secured Payment Collector Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND | Hosted Payment Fields or Secured Payment Collector token. |
three-d-secure | container | Optional | Container of three-d-secure properties. |
transaction-meta-data | container | Optional | Container of transaction-meta-data properties. |
wallet | container | Required in AUTH_ONLY and AUTH_CAPTURE if usingApple Pay or Google Pay™ Not relevant for CAPTURE, AUTH_REVERSAL, and REFUND | See wallet. |
vendors-info | container | Relevant for Marketplaces Optional | Container of vendors-info properties. |
level-3-data | container | Optional | Container of level-3-data properties. |
store-card | boolean | Optional | Indicates whether or not to store the shopper's payment data. Possible values:
|
transaction-order-source | string | Optional | Identifies the order type. The only option is MOTO (Mail Order Telephone Order). Any other option is ignored. |
transaction-initiator | string | Optional | Identifies who initiated the order. Options are: Refer to the 3-D Secure Guide. |
network-transaction-info | container | Optional | See network-transaction-info |
Response
| Property Name | Type | Description |
|---|---|---|
card-transaction-type | string | Defines the type of transaction. Values can be: AUTH_ONLY AUTH_CAPTURE CAPTURE AUTH_REVERSAL REFUND |
transaction-id | string | BlueSnap identifier for the transaction. |
original-transaction-id | 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. |
merchant-transaction-id | string | Merchant's unique ID for a new transaction. Between 1 - 50 characters. |
soft-descriptor | string | Description of the transaction, which appears on the customer's credit card statement. |
descriptor-phone-number | string | Merchant's support phone number that will appear on the shopper's credit card statement. |
tax-reference | string | Unique ID for the tax quote. Refer to the Taxes guide for further details. |
amount | decimal | Amount to be charged in the transaction, including decimal points. |
currency | string | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
transaction-approval-date | string | The date the transaction was approved. |
transaction-approval-time | string | The time the transaction was approved. This is in Pacific time. |
open-to-capture | decimal | Remaining authorization amount available for capture. |
vaulted-shopper-id | integer | ID of an existing vaulted shopper. |
card-holder-info | container | Container of card-holder-info properties. |
credit-card | container | Container of credit-card properties. |
three-d-secure | container | Container of three-d-secure properties. |
transaction-meta-data | container | Container of transaction-meta-data properties. |
processing-info | container | Container of processing-info properties. |
fraud-result-info | container | Container of fraud-result-info properties. |
chargebacks | container | Container of chargebacks properties. |
refunds | container | Container of refunds properties. |
wallet | container | Container of Apple Pay or Google Pay wallet properties. |
vendors-info | container | Container of vendors-info properties. |
level-3-data | container | Container of level-3-data properties. |
store-card | boolean | Indicates if the shopper provided permissions to store their payment data. Possible values:
|
network-transaction-info | container | See network-transaction-info |