Skip to main content
Vindicia Knowledge Center

The Transaction object

The Transaction object

Attributes

Transaction

Name Type Description
object string Value is “Transaction”
id string A merchant-specified unique identifier. Optionally, this object can be identified by its vid. For transactions created automatically, this field will be assigned by CashBox.
vid string A Globally Unique Identifier (GUID) for this object. This field is created by CashBox.
created datetime The time this transaction was initiated.
amount decimal The net amount of the charge presented by this transaction, as a decimal. Must be positive (zero allowed).
original_amount decimal Used with a partial payment; this read-only field reflects the original amount of the transaction, as a decimal.
currency string ISO 4217 Currency Code of this transaction
division_number string The Merchant’s division, reporting or processing group as defined with their payment processor.
previous_id string The identifier of a previous version of this transaction.
account Account The account (customer) associated with this transaction.
source_payment_method PaymentMethod The Payment Method (e.g., a credit card) associated with charges for this transaction. In the case of a CashBox transaction, this payment method will be used to perfom the actual billing. For ECP/ACH inbound transactions (i.e. merchant is getting paid by a customer) populate this field.
dest_payment_method PaymentMethod The Payment Method to recieve funds from this transaction. Applies only for deposits, ECP/ACH outbound, and transfers.
ecp_transaction_type enum For ECP/ACH-specific types. Values can be All,Inbound,InboundOutbound,NA,Outbound,Transfer
status_log TransactionStatus[] A log of various TransactionStatus entries associated with this transaction.
payment_processor string The payment processor used for processing this transaction.
payment_processor_transaction_id string The identifier assigned to the Transaction by the Payment Processor.
shipping_address Address The shipping address associated with this transaction, if any.
metadata hash A set of key/value pairs that you can attach to an object. Useful for storing additional information. For transactions resulting from a subscription, the meta data is also inherited from the subscription.
items TransactionItem[] The array of Transaction Items belonging to this transaction. Items correspond to the charges, discounts, credits, and taxes.
affiliate string Merchant’s ID for the channel or affiliate associated with this transaction, if any. This is a free-form string of 128 characters or less.
sub_affiliate string Affiliate ID for a more granular channel component (see merchant_affiliate_id).
user_agent string Information on the source of the transaction, such as the Customer’s user-agent string, as presented by the browser.
preferred_notification_language string ISO language code string. Transaction value will override any language setting on the account.
source_mac_address string MAC address of the customer (primarily intended for ISP usage), may be left blank if unavailable or inappropriate.
source_ip string End-customer’s source IP associated with this transaction.
billing_descriptor string Optional “soft descriptor” to send to the payment processor for this transaction.
sales_tax_address Address An system-generated billing or shipping address actually used in calculation of sales tax.
verification_code string External verification response (e.g. Verified by Visa, MasterCard SecureCode).
subscription_sequence integer The subscription’s billing cycle for which this transaction collects funds. As a zero-based index, this indicates the renewal number.
billing_plan_sequence integer The billing cycle for which this transaction collects funds - as counted as a zero-based index from the last billing plan change for the associated subscription.
mandate Mandate The Direct Debit customer mandate associated with this transaction.
original_billing_date datetime The original scheduled billing date associated with the billing for which this transaction collects funds. For an initial attempt, this is the same as the transaction date; for a retry transaction this is the original attempt date.
billing_attempt integer The zero-based index counting the number of transaction attempts this particular transaction represents in collecting for given subscription billing cycle.
subscription Subscription The subscription for which this transaction collects funds.
score integer The chargeback and fraud risk score generated by CashBox.
score_codes scorecode The reason codes justifying the risk score.
policy hash The policy object governing Transaction behavior.
to_be_captured boolean Indicator of whether the transaction is currently pending capture.

TransactionStatus

Name Type Description
object string Value is “TransactionStatus”
status enum Status of the Transaction. Values can be New,AuthorizationPending,AuthorizedPending,Authorized,AuthorizedForValidation,Cancelled,Captured,Settled,Refunded,Pending
created datetime The effective datetime of this status
payment_method_type enum Type of Payment Method (clarifies status). Values can be CreditCard, PayPal,ECP ,DirectDebit,Token,HostedPage,Boleto,MerchantAcceptedPayment,CarrierBilling, Amazon,Skrill,ApplePay
credit_card_status TransactionStatusCreditCard  
ecp_status TransactionStatusECP  
boleto_status TransactionStatusBoleto  
hosted_page_status TransactionStatusHostedPage  
paypal_status TransactionStatusPayPal  
direct_debit_status TransactionStatusDirectDebit  
carrier_billing_status TransactionStatusCarrierBilling  
amazon_status TransactionStatusAmazon  
skrill_status TransactionStatusSkrill  
apple_pay_status TransactionStatusApplePay  
vin_avs enum AVS result. Values can be FullMatch,PartialMatch,NoMatch,IssuerError,NoOpinion,NotSupported
funding_source_balance decimal  

Transaction Item

Name Type Description
object string Value is “TransactionItem”
sku string The SKU or unique identifier of the product purchased with this item (for one-time transactions this is an ad-hoc value.
index_number integer Sequential index of all items on the transaction.
item_type enum(TransactionItemType)  
name string Merchant-provided name or inherited description of the product purchased
subscription_item SubscriptionItem SubscriptionItem associated with this item.
price decimal unit price of this item
metadata hash A set of key/value pairs that you can attach to an object. Useful for storing additional information.
quantity decimal The unit quantity for the item; for license-based products this is the license/seat quantity.
tax_classification string The tax code or classification applicable to this item.
tokens TokenAmount[] Tokens granted to the account on this transaction for purchasing this item
campaign_code string Campaign code redeemed on this TransactionItem.
campaign_id string The unique identifier for a campaign applied to this item.
campaign_description string Detailed description of the campaign for the discount on this item, if there is one.
service_period_starts datetime The start date for the period the charge on this item covers.
service_period_ends datetime The end date for the period the charge on this item covers.
tax_type string Fixed Tax definition (read only).
tax TaxItem[] array to list the individual tax items associated with the corresponding transactionItem.
related_transactions string[] List of merchantTransactionIds for all Transactions related to this item. e.g. For a credit resulting from the removal of an SubscriptionItem, this will contain the list of all Transactions that originally billed for the item within the time frame covered by the credit.
item_refunds TransactionItemRefundSummary[] Detail on item-level refunds applied to this item.
discount decimal The total discount amount applied to this item.
subtotal decimal The pre-tax (post-discount) subtotal.
total decimal The grand total of this item
  • cURL
  • Java
Example Object
{
    "object": "Transaction",
    "id": "FLX200001621",
    "vid": "d137d38973040467ed65b1d7c331a22ef14605c8",
    "created": "2016-05-31T15:12:28-07:00",
    "amount": 10.98,
    "currency": "USD",
    "account": {`...`},
    "source_payment_method": {`...`},
    "status_log": {
        "object": "List",
        "data": [
            {
                "object": "TransactionStatus",
                "status": "Captured",
                "created": "2016-05-31T15:14:04-07:00",
                "payment_method_type": "CreditCard",
                "credit_card_status": {
                    "object": "TransactionStatusCreditCard",
                    "auth_code": "T00"
                }
            },
            {`...`},
            {`...`}
        ],
        "total_count": 3
    },
    "payment_processor": "Test",
    "payment_processor_transaction_id": "FLX200001621",
    "shipping_address": {`...`},
    "metadata": {
        "vin:RetryNumber": "0",
        "vin:recurring": "1",
        "vin:BillingCycle": "0"
    },
    "items": {
        "object": "List",
        "data": [
            {
                "object": "TransactionItem",
                "sku": "plan_1234",
                "index_number": 1,
                "item_type": "Purchase",
                "name": "Simple Monthly Billing Plan",
                "quantity": 1,
                "tax_classification": null,
                "service_period_starts": "2016-05-27T00:00:00-07:00",
                "service_period_ends": "2016-06-26T00:00:00-07:00",
                "tax_type": "Exclusive Sales",
                "total": 0
            },
            {`...`},
            {`...`},
            {`...`}
        ],
        "total_count": 4
    },
    "sales_tax_address": {`...`},
    "subscription_sequence": 1,
    "billing_plan_sequence": 1,
    "original_billing_date": "2016-05-27T00:00:00-07:00",
    "billing_attempt": 0,
    "subscription": {`...`},
    "to_be_captured": true
}
          
{
    "object": "Transaction",
    "id": "FLX200001621",
    "vid": "d137d38973040467ed65b1d7c331a22ef14605c8",
    "created": "2016-05-31T15:12:28-07:00",
    "amount": 10.98,
    "currency": "USD",
    "account": {`...`},
    "source_payment_method": {`...`},
    "status_log": {
        "object": "List",
        "data": [
            {
                "object": "TransactionStatus",
                "status": "Captured",
                "created": "2016-05-31T15:14:04-07:00",
                "payment_method_type": "CreditCard",
                "credit_card_status": {
                    "object": "TransactionStatusCreditCard",
                    "auth_code": "T00"
                }
            },
            {`...`},
            {`...`}
        ],
        "total_count": 3
    },
    "payment_processor": "Test",
    "payment_processor_transaction_id": "FLX200001621",
    "shipping_address": {`...`},
    "metadata": {
        "vin:RetryNumber": "0",
        "vin:recurring": "1",
        "vin:BillingCycle": "0"
    },
    "items": {
        "object": "List",
        "data": [
            {
                "object": "TransactionItem",
                "sku": "plan_1234",
                "index_number": 1,
                "item_type": "Purchase",
                "name": "Simple Monthly Billing Plan",
                "quantity": 1,
                "tax_classification": null,
                "service_period_starts": "2016-05-27T00:00:00-07:00",
                "service_period_ends": "2016-06-26T00:00:00-07:00",
                "tax_type": "Exclusive Sales",
                "total": 0
            },
            {`...`},
            {`...`},
            {`...`}
        ],
        "total_count": 4
    },
    "sales_tax_address": {`...`},
    "subscription_sequence": 1,
    "billing_plan_sequence": 1,
    "original_billing_date": "2016-05-27T00:00:00-07:00",
    "billing_attempt": 0,
    "subscription": {`...`},
    "to_be_captured": true
}
          

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top