V2
This topic shows information relevant specifically for Subscribe REST API version 20210401 referred to as V2Attributes
| 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 Subscribe. |
| vid | string | A Globally Unique Identifier (GUID) for this object. This field is created by Subscribe. |
| 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 | Payment Method | The Payment Method (e.g., a credit card) associated with charges for this transaction. In the case of a Subscribe transaction, this payment method will be used to perform the actual billing. For ECP/ACH inbound transactions (i.e. merchant is getting paid by a customer) populate this field. |
| dest_payment_method | Payment Method | The Payment Method to receive 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 | Transaction Status | 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 | Transaction Item | 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 | Subscribe-derived Address object provided to the Merchant’s Tax Vendor for Invoice/Transaction tax calculation. This attribute will be null until the Invoice has become “Due” AND an Address object can be generated from either the Invoice’s Account (shipping_address) or PaymentMethod (billing_address).Note: Read-only attribute |
| 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 Subscribe. |
| score_calculated | datetime | The datetime the score was calculated. |
| score_calculated_orig | datetime | The datetime the score was originally calculated. |
| score_codes | Score Code | The reason codes justifying the risk score. |
| distance_ip_ba | decimal | The distance from the IP Address to the Billing Address. |
| avs_code | string | AVS Code |
| cvn_code | string | CVN Code. |
| cvn_checked | boolean | Shows if the CVN was checked for this transaction. |
| payment_provider_response | string | The response from the payment provider and the applicable action to take. Common responses are:- Successful: Approved: The Payment Processor has accepted the transaction. - Soft Failure: Decline: A payment capture attempt has failed but may indicate that an additional attempt may succeed, such as when the customer has insufficient funds. The classification of the type of fail is performed according to the error code returned by the payment provider and follows industry standards and recommendations. - Hard Failure: Reject: A payment capture attempt has failed and indicates that additional attempts will subsequently fail, such as when the account has been terminated. The classification of the type of fail is performed according to the error code returned by the payment provider. Hard fails are not resubmitted for capture. |
| policy | hash | The policy object governing Transaction behavior. |
| policy: ignore_avs_policy | boolean | Indicates whether to evaluate any custom or default AVS (card Address Verification Service) policy. |
| policy: ignore_cvn_policy | boolean | Indicates whether to evaluate any custom or default CVN (card security code) policy. |
| policy: min_chargeback_probability | integer | If Chargeback Probability from risk scoring is greater than this, the transaction will fail. Default is 100. |
| policy: send_email_notification | boolean | Policy flag, when enabled and when email templates have been implemented, it triggers an email notification from Subscribe to the Account relevant for the Transaction. |
| policy: enable_3ds | boolean | Enable the 3DS payment standard for strong customer authentication. A merchant configuration serves as a higher level indication whether 3DS is used by the merchant. When available for use, you can enable 3DS flow per subscription, transaction, or payment method. |
| policy: campaign_code | Campaign code | An optional Coupon or Promotion code to be applied to any applicable items in the subscription in order to provide a discount. |
| policy: discount_tickets_to_distribute | Discount Tickets | An array of Discount Tickets to be applied to any applicable items in the transaction in order to provide a discount. |
| to_be_captured | boolean | Indicator of whether the transaction is currently pending capture. |
Example Object
{
"object": "Transaction",
"id": "kqNrhlCLisb81er3H7Qw",
"vid": "979d9514b6e17cdef4876fffd98771c0e0ffce9d",
"created": "2021-06-20T11:07:17-07:00",
"amount": 65.70,
"currency": "USD",
"division_number": "TEST_CreditCard_USD",
"account": {
"object": "Account",
"id": "PQt98tx66YanwiqB6ldy-A-W6Cw",
"vid": "987053a77d26bb018f227aee623fbb5fea40ab72",
"created": "2021-06-20T11:07:18-07:00",
"email": "devnull@vindicia.com",
"email_type": "html",
"company": "Lorem Ipsum Inc",
"name": "Forest Chump",
"shipping_address": {
"object": "Address",
"vid": "6e80462c7e39a353f2a634b37601f8f02c614df3",
"name": "Forest Chump",
"line1": "11235 Fibonacci St.",
"city": "San Mateo",
"district": "CA",
"postal_code": "94403",
"country": "US",
"phone": "(650) 555-1212x42"
},
"payment_methods": {
"object": "List",
"data": [
{
"object": "PaymentMethod",
"id": "vi_tiJYesUPJioK-GQbjkRv2BpfHok",
"vid": "9db26b18834175503c96347c503f3c0192f72b47",
"created": "2021-06-20T11:07:28-07:00",
"type": "CreditCard",
"credit_card": {
"object": "CreditCard",
"vid": "0e8a7c9c48ff4951fcb399f281759b09acf35feb",
"account": "541267XXXXXX7060",
"bin": "541267",
"last_digits": "7060",
"account_length": 16,
"expiration_date": "202306",
"last_au_request_date": null,
"last_update_date": null
},
"account_holder": "Forest Chump",
"billing_address": {
"object": "Address",
"vid": "767af63f4c9cf3ef3176ed4dd882d84b0e07ac68",
"name": "Forest Chump",
"line1": "11235 Fibonacci St.",
"city": "San Mateo",
"district": "CA",
"postal_code": "94403",
"country": "US",
"phone": "(650) 555-1212x42"
},
"customer_specified_type": "VI",
"primary": true,
"active": true
}
],
"total_count": 1
}
},
"source_payment_method": {
"object": "PaymentMethod",
"id": "vi_tiJYesUPJioK-GQbjkRv2BpfHok",
"vid": "9db26b18834175503c96347c503f3c0192f72b47",
"created": "2021-06-20T11:07:28-07:00",
"type": "CreditCard",
"credit_card": {
"object": "CreditCard",
"vid": "0e8a7c9c48ff4951fcb399f281759b09acf35feb",
"account": "541267XXXXXX7060",
"bin": "541267",
"last_digits": "7060",
"account_length": 16,
"expiration_date": "202306",
"last_au_request_date": null,
"last_update_date": null
},
"account_holder": "Forest Chump",
"billing_address": {
"object": "Address",
"vid": "767af63f4c9cf3ef3176ed4dd882d84b0e07ac68",
"name": "Forest Chump",
"line1": "11235 Fibonacci St.",
"city": "San Mateo",
"district": "CA",
"postal_code": "94403",
"country": "US",
"phone": "(650) 555-1212x42"
},
"customer_specified_type": "VI",
"primary": true,
"active": true
},
"status_log": {
"object": "List",
"data": [
{
"object": "TransactionStatus",
"status": "Authorized",
"created": "2021-06-20T11:07:27-07:00",
"payment_method_type": "CreditCard",
"credit_card_status": {
"object": "TransactionStatusCreditCard",
"auth_code": "T00"
},
"note": "T00 - NA"
},
{
"object": "TransactionStatus",
"status": "New",
"created": "2021-06-20T11:07:24-07:00",
"payment_method_type": "CreditCard",
"credit_card_status": {
"object": "TransactionStatusCreditCard",
"auth_code": "T00"
}
}
],
"total_count": 2
},
"payment_processor": "Test",
"payment_processor_transaction_id": "kqNrhlCLisb81er3H7Qw",
"shipping_address": {
"object": "Address",
"vid": "ff1483086d220845bacd0753e0216b99b57f2fd0",
"name": "Forest Chump",
"line1": "11235 Fibonacci St.",
"city": "San Mateo",
"district": "CA",
"postal_code": "94403",
"country": "US",
"phone": "(650) 555-1212x42"
},
"items": {
"object": "List",
"data": [
{
"object": "TransactionItem",
"sku": "OXKaObGlhi4hyMLEwMGWpiTiEhk",
"index_number": 1,
"item_type": "Purchase",
"name": "waffle cone",
"price": 66.66,
"quantity": 1,
"tax_type": "Exclusive Sales",
"tax": {
"object": "List",
"data": [
{
"object": "TaxItem",
"jurisdiction": "CITY_68252",
"name": "SAN MATEO CITY SALES TAX",
"amount": 0.15,
"external_tax_name": "CA CITY TAX",
"external_jurisdiction_name": "SAN MATEO",
"tax_rate": 0.0025
},
{
"object": "TaxItem",
"jurisdiction": "COUNTY_081",
"name": "SAN MATEO COUNTY SALES TAX",
"amount": 0.15,
"external_tax_name": "CA COUNTY TAX",
"external_jurisdiction_name": "SAN MATEO",
"tax_rate": 0.0025
},
{
"object": "TaxItem",
"jurisdiction": "SPECIAL_EMBG0",
"name": "SAN MATEO COUNTY DISTRICT TAX SP SPECIAL SALES TAX",
"amount": 1.2,
"external_tax_name": "CA SPECIAL TAX",
"external_jurisdiction_name": "SAN MATEO COUNTY DISTRICT TAX SP",
"tax_rate": 0.02
},
{
"object": "TaxItem",
"jurisdiction": "SPECIAL_EMTY0",
"name": "SAN MATEO CO LOCAL TAX SL SPECIAL SALES TAX",
"amount": 0.6,
"external_tax_name": "CA SPECIAL TAX",
"external_jurisdiction_name": "SAN MATEO CO LOCAL TAX SL",
"tax_rate": 0.01
},
{
"object": "TaxItem",
"jurisdiction": "STATE_06",
"name": "CALIFORNIA STATE SALES TAX",
"amount": 3.6,
"external_tax_name": "CA STATE TAX",
"external_jurisdiction_name": "CALIFORNIA",
"tax_rate": 0.06
}
],
"total_count": 5
},
"item_refunds": {
"object": "List",
"data": [],
"total_count": 0
},
"item_discounts": {
"object": "List",
"data": [
{
"object": "TransactionItemDiscount",
"sku": "VIN_CampaignDiscount",
"name": "Campaign Discount, 2021-06-20 11:07:20, ujo4cI2dkVif_WORaqvxur4XwNY",
"amount": -166.67,
"discount_ticket": {
"object": "DiscountTicket",
"id": "ID_cCGiUuI6M9ebya92TI_VSgivsWA-RSR6B3SMKHKEFU5D",
"vid": "d862d2ab2861a6250db6efae9925953c919a27fa",
"campaign_code": "FU5D",
"state": "Active",
"added_date": "2021-06-20T11:07:20-07:00",
"start_billing_sequence": 0,
"end_billing_sequence": 0
}
}
],
"total_count": 1
},
"discount": -6.66,
"subtotal": 60.00,
"tax_total": 5.70,
"total": 65.70
},
{
"object": "TransactionItem",
"sku": "Total Tax",
"index_number": 2,
"item_type": "Purchase",
"name": "Total Tax",
"price": 0,
"quantity": 1,
"tax_classification": "TaxExempt",
"tax_type": "Exclusive Sales",
"tax": {
"object": "List",
"data": [
{
"object": "TaxItem",
"jurisdiction": "CITY_68252",
"name": "SAN MATEO CITY SALES TAX",
"amount": 0.15 },
{
"object": "TaxItem",
"jurisdiction": "COUNTY_081",
"name": "SAN MATEO COUNTY SALES TAX",
"amount": 0.15
},
{
"object": "TaxItem",
"jurisdiction": "SPECIAL_EMBG0",
"name": "SAN MATEO COUNTY DISTRICT TAX SP SPECIAL SALES TAX",
"amount": 1.2 },
{
"object": "TaxItem",
"jurisdiction": "SPECIAL_EMTY0",
"name": "SAN MATEO CO LOCAL TAX SL SPECIAL SALES TAX",
"amount": .6
},
{
"object": "TaxItem",
"jurisdiction": "STATE_06",
"name": "CALIFORNIA STATE SALES TAX",
"amount": 3.6
}
],
"total_count": 5
},
"item_refunds": {
"object": "List",
"data": [],
"total_count": 0
},
"discount": 0,
"subtotal": 0,
"tax_total": 0,
"total": 5.7
}
],
"total_count": 2
},
"source_ip": "63.201.132.182",
"sales_tax_address": {
"object": "Address",
"vid": "99bae0b643b6b9991a6fd89b571b5811aed93ece",
"name": "Forest Chump",
"line1": "11235 Fibonacci St.",
"city": "SAN MATEO",
"district": "CA",
"postal_code": "94403",
"country": "US"
},
"cvn_checked": false
}
Example Object
{
"object": "Transaction",
"id": "FLX200001621",
"vid": "d137d38973040467ed65b1d7c331a22ef14605c8",
"created": "2020-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": "2020-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": "2020-05-27T00:00:00-07:00",
"service_period_ends": "2020-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": "2020-05-27T00:00:00-07:00",
"billing_attempt": 0,
"subscription": {...},
"to_be_captured": true
}