AllDataTypes          

An account (i.e., a customer)

VID

Vindicia's Globally Unique Identifier (GUID) for this object

merchantAccountId

A merchant's unique identifier for this account. Common forms include a database ID, a login, a GUID, or an email address. This is enforced as a unique key in Vindicia's system, so attempting to create duplicate Accounts with the same merchantAccountId will generally update the old rather than creating a new. This is a free-form string of 128 or fewer characters.

emailAddress

The email address associated with the account. Please note that, even if the emailAddress is used as the merchantAccountId, for email notifications to function properly that data must be duplicated, here. This is a free-form, 255 character or fewer string. No email address validation is performed on this field.

emailTypePreference

Whether the account prefers to receive email in a text form or an html form.

preferredLanguage

The account's preferred language of communication, specified as an ISO language string.

warnBeforeAutobilling

Whether the customer prefers to be warned prior to autobilling activity. The default value for this is set on a merchant-by-merchant basis.

company

Customer's company, if specified. This is a free-form string of 255 or fewer characters.

name

Customer's name, if specified. This generally corresponds to the name on card, and is a free-form string of 255 or fewer characters.

shippingAddress

The customer's shipping address.

paymentMethods

An array of payment methods (e.g., a credit cards) to be associated with the customer. The array should be in order by preference. Future link=AutoBill creations that do not include explicit payment information will use the first PaymentMethod in this array.

nameValues

Optional array of name/value pairs the merchant wishes to associate with an Account

taxExemptions

Default exemptions to apply

tokenBalances

An array of TokenAmount objects describing the balances this account has. These are READ ONLY on Account->update() if the Account already exists.

Describes an activity by a customer. This class contains the common subset of information used in all activity reports.

account

Account (customer) this activity describes

activityType

Type of activity

activityArgs

Arguments specific to the type of activity

timestamp

Time the activity occurred

Information about a user cancellation

reason

The reason for the cancellation

confirmationCode

Confirmation code for the cancellation

initiator

Type of initiator who made the cancellation

Information about an email contact with a customer

srcEmail

The sender's address

destEmail

The recipient's address

note

A note about the contents of the email

Information about physical fulfillment of an order

merchantTransactionId

The ID of the transaction this is fulfilling

shipper

Description of who the shipping agent is (e.g., UPS)

trackingString

Tracking information on the package

shippingAddress

The address shipped to

delivered

Whether delivery is complete or not at this time

receivedTs

Receive time information from shipping agent

receiptName

Recipient's name from shipping agent

Information about a login

ip

The IP the login came from

Information about a logout

ip

The IP the logout request came from, or null if the logout is implicit (from a timeout)

Generic activity type. Should not be used permanently; provides a temporary means to bridge to new activities without a SOAP release. Contact Vindicia before submitting data of this type.

type

Type string, provided by Vindicia

name

Name for this activity

value

Value for this activity

Information about a merchant customer

note

The note about a merchant customer

Information about a phone contact with a customer

srcPhoneNumber

The caller's number

destPhoneNumber

The callee's number

cidPhoneNumber

CID (Caller ID) information, if available

aniPhoneNumber

ANI (800 Caller ID) information, if available)

durationSeconds

Duration of the call, in seconds

note

Notes on the call

type

Type of call

A "master class" for activity subclasses. While WSDL does not appear to allow for the definition of literal subclasses, this provides similar results. methodLink=report takes an argument of this class. Simply fill only the field necessary for the type of activity being recorded. Note that some activities may not require additional information. For example, if submitting a uriView, set uriviewArgs to a previously filled ActivityURIView.

loginArgs

Information pertaining to a login

logoutArgs

Information pertaining to a logout

uriviewArgs

Information pertaining to a URI view

phoneArgs

Information pertaining to a phone contact

emailArgs

Information pertaining to an email contact

fulfillmentArgs

Information pertaining to physical fulfillment of a product. For electronic fulfillment, use uriviewArgs.

usageArgs

Information on usage of a service by a customer

namedvalueArgs

Arbitrary name-value pairs describing an activity. Please contact your Vindicia technical support adviser prior to using this field, as it requires support on the server-side, as well. The intent is to allow merchants with novel activities to begin reporting without requiring a SOAP protocol revision, but significant work is still required to support it on the SOAP server.

cancellationArgs

Arbitrary name-value pairs describing an activity. Please contact your Vindicia technical support adviser prior to using this field, as it requires support on the server-side, as well. The intent is to allow merchants with novel activities to begin reporting without requiring a SOAP protocol revision, but significant work is still required to support it on the SOAP server.

noteArgs

Information pertaining to a note.

Information about a user visiting a document

ip

The IP the customer is visiting from

uri

The URI visited

size

Size of the download

bytesTransferred

Bytes actually transferred, if known

transferTime

Number of second the transfer took

description

Description of the URI or object downloaded

Information on usage of a service by a customer. Please convert all durations to seconds.

description

Description of this usage

total

Total duration of the usage by customer

lastDay

Usage by customer in last day

lastWeek

Usage by customer in last week

lastMonth

Usage by customer in last month

lastYear

Usage by customer in last year

lastUsageDate

Last date of usage by the customer

A physical address

VID

Vindicia's Globally Unique Identifier (GUID) for this object. If not specified, will be assigned.

name

Name of the person or organization who receives mail at this address. A free-form string of 255 or fewer characters.

addr1

Address line 1. A free-form string of 255 or fewer characters.

addr2

Address line 2. A free-form string of 255 or fewer characters.

addr3

Address line 3. A free-form string of 255 or fewer characters.

city

City. A free-form string of 64 or fewer characters.

county

County. A free-form string of 64 or fewer characters.

district

District (i.e., state or province). A free-form string of 255 or fewer characters.

postalCode

Postal code (i.e., ZIP code). A free-form string of 255 or fewer characters.

country

Country. A free-form string of 255 or fewer characters.

phone

Voice phone. A free-form string of 64 or fewer characters.

fax

Fax phone. A free-form string of 64 or fewer characters.

latitude

Latitude as signed decimal value. Filled in by Vindicia in some circumstances.

longitude

Longitude as signed decimal value. Filled in by Vindicia in some circumstances.

An array of Account items.

An array of AutoBill items.

An array of BillingPlanPeriod items.

An array of BillingPlanBillPrice items.

An array of BillingPlan items.

An array of CancelResult items.

An array of CaptureResult items.

An array of chargebacks

An array of EmailTemplate items

An array of entitlements

An array of entitlement ids

An array of MetricStatistics items.

An array of NameValuePair items

An array of PaymentMethod objects.

An array of Product objects

An array of Refund

An array of SalesTax items.

An array of ScoreCode items

An array of TaxExemption items.

An array of TaxExemption items.

An array of TokenAmount objects

An array of TokenTransaction objects

An array of Token objects

An array of TransactionItems

An array of TransactionStatus items.

An array of Transactions

Authentication information for this request.

version

The version of the request. Current supported version is 3.1

login

The login ID to use. This ID is assigned at account creation time and generally has the suffix "Soap".

password

The password to use.

A description of how to bill a customer on a regular basis. An AutoBill is a, with a little extra information, a join between a link=Product (to describe what is being purchased) an link=Account (to descibe who is purchasing it) and a link=BillingPlan (to describe precisely what amounts are billed, when).

VID

Vindicia's Globally Unique Identifier (GUID) for this object. When creating new, this field should generally be blank. Most methods will also allow an AutoBill to be referenced based upon the merchantAutoBillId if that is more appropriate the merchant's application.

merchantAutoBillId

A merchant's unique identifier (e.g. serial number) for this AutoBill. Common forms include a database ID or random string. This is a free-form string of 256 or fewer bytes.

account

The Account (i.e., Customer) account associated with this AutoBill. When creating a new AutoBill either an existing VID or merchantAccountId must be specified or a new Account will be created.

product

The Product to be autobilled. When creating a new AutoBill either an existing VID or sku must be specified or a new Product will be created. It is generally recommended that Products be created explicitly in advance rather and implicitly.

billingPlan

The BillingPlan from which to create the ArrayOfAutoBillPeriods. This object describes precisely what values should be billed, when.

paymentMethod

The PaymentMethod used for this AutoBill. When creating a new AutoBill an existing VID must be specified or a new PaymentMethod will be created. If no PaymentMethod is specified on creation of a new AutoBill, the paymentMethod from the link=Account is used, if available.

currency

ISO 4217 currency code to be used for this transaction. Note that the currency code must map to a currency on a previously defined link=BillingPeriodPlan

customerAutoBillName

Customer-defined, optional name for this autobilling object (e.g, 'Home Subscription').

status

Status of AutoBilling as enumerated in AutoBillStatus. On creation, should be set to 'New' or left blank

startTimestamp

Time this autobilling begins. If not specified, defaults to the current time.

sourceIp

Source IP this autobill was requested from (the customer's, not the merchant's). Useful in fraud prevention.

billingStatementIdentifier

Optional string that should be displayed on a customer's billing statement when they are charged. Support for this string and its allowable format depends on your payment processor. Please consult your Vindicia contact if you wish to use this

billingDay

The day of the month the customer is billed. An integer between 1 and 31. If a day of month is specified that does not exist in a given month (e.g., 31 does not exist in February) all those transactions will be billed on the last day of that month in those conditions on monthly rebills.

minimumCommitment

Number of billing cycles the customer is contractually obligated to complete before cancelling. The only impact this has is upon the AutoBill->cancel() method, which has various modes it supports depending on this value.

merchantAffiliateId

Merchant's ID for the affiliate that submitted this AutoBill, if any. This is a free-form string of 128 characters or less.

merchantAffiliateSubId

Merchant's sub-ID for the affiliate that submitted this AutoBill. Allows for finer tracking of affiliate programs (e.g., a campaign). This is a free-form string of 128 characters or less.

warnOnExpiration

Set to true if the customer should be warned of a pending expiration of a trial period or finite subscription. The warning email will be sent a number of days before the expiration date as set in expire_warning_days in the BillingPlanPeriod corresponding to the trial or end of subscription. Defaults to false.

Describes the billing terms for a Product. While a Product describes the service or item purchased, the BillingPlan describes how amounts should be billed over time. More than one Product may hence use the same BillingPlan. For example, a music subscription service might have a 'music subscription' product, but multiple BillingPlans at different rates with different comittments. A common name for a BillingPlan is a 'Subscription Tier'.

VID

Vindicia's Globally Unique Identifier (GUID) for this object. If you do not have a VID, a VID will be provided for you.

merchantBillingPlanId

Merchant's unique ID for this item. Common forms include a database ID. If there is no appropriate unique identifier for this in the merchant's system, a VID may be used, instead. Free-form string 255 characters or fewer.

description

Description of this item. A free-form string 2048 characters or smaller.

status

Status of BillingPlan as enumerated in BillingPlanStatus - i.e., whether it is still ative, or not.

periods

Array of items describing billings. This array is used sequentially by the AutoBill object to create actual future billings. This allows for the creation of complex billing plans (e.g. 1 month free then 3 months for 9.99/mo then 12 months for 15.99/mo).

prenotifyDays

Number of days before billing prenotification emails are sent out; if unspecified, defaults to an automatic value based on the rebill period.

endOfLifeTimestamp

Time at which BillingPlan will go to end of life; i.e., when mandatory upgrade messaging begins. After this timestamp no more renewals will be allowed. If unspecifed, the product has no end of life set at this time.

nameValues

Optional array of name/value pairs the merchant wishes to associate with a BillingPlan

merchantEntitlementIds

Optional array of merchant defined ids that indicate entitlement for specific BillingPlan features. Allows merchant to ask the question, 'Is Account X allowed to access Feature Y?' May be unspecified if Vindicia entitlements are not being used to track access.

billingStatementIdentifier

The string that should be displayed on a customer's billing statement when they are charged for this BillingPlan. Please note that this value is probably constrained by the Payment Provider and should not be used without prior consultation with Vindicia Engineering.

A quantity of time and a set of prices to rebill. Used as part of a BillingPlan object.

type

The unit the quantity describes, as enumerated in BillingPeriodType.

quantity

Quantity of the period (in days, weeks, months, etc). Must be a positive integer.

cycles

Number of times to bill; 0 is inifitely recurring

prices

List of prices for various currencies.

expireWarningDays

Number of days before expiration of this billing period to send a warning email.

doNotNotifyFirstBill

Set to true if the first bill for this billing period should not generate a prenotification email, e.g., the first bill after a free trial for which an expiration warning email is already sent.

Defines a price point for a BillingPlan

amount

Amount to bill. Must be zero (free) or positive.

currency

ISO 4217 Currency Code of billing, defaults to USD

priceListName

Name of price list containing this price. This is free-form string of 255 characters or less and is generally a description of this price point.

tokenAmount

The number of tokens required to purchase this billing plan

Details for a Boleto Bancario payment

fiscalNumber

Fiscal number appearing on the customer's Boleto Banacario payment slip

.

returnCode

The code describing the success or reason of failure for the cancellation. 200:Ok - Cancel succeeded. 400:Transaction already captured and hence not cancellable. 404:Unable to load transaction. If the transaction may not be loaded by VID or merchantTransactionId. 405:Must specify a transaction that has been Authorized.

merchantTransactionId

Merchant transaction identifier.

.

returnCode

The code describing the success or reason of failure for the capture. 200:Ok - Capture succeeded. 402:Unable to re-authorize an AuthExpired transaction. 404:Unable to load transaction. If the transaction may not be loaded by VID or merchantTransactionId. 405:Must specify a transaction that has been Authorized. 500:Internal failure.

merchantTransactionId

Merchant transaction identifier.

originaMerchantTransactionId

Merchant transaction identifier for the original transaction, if a re-auth was done.

Information about a chargeback

VID

Vindicia's Globally Unique Identifier (GUID) for this object. This field is created by Vindicia and is provided for merchants who don't track their own internal IDs on transactions to have a unique handle to track by. Generally speaking it may be safely ignored in favor of the merchantTransactionId at the merchant's preference. This is a 40-character freeform string.

amount

The amount charged back, in the settlement currency. Generally the same as the amount of the original transaction, although it is not unheard of for consumers to only chargeback part of a transaction. Vindicia does not provide at this time any information about the individual items charged back. Also note that, because of exchange rates, transactions across currencies may chargeback at different amounts than the original.

currency

Settlement ISO 4217 Currency Code of this transaction; defaults to USD if not specified.

presentmentAmount

The amount charged back, in the presentment currency. Generally the same as the amount of the original transaction, although it is not unheard of for consumers to only chargeback part of a transaction. Vindicia does not provide at this time any information about the individual items charged back. Also note that, because of exchange rates, transactions across currencies may chargeback at different amounts than the original.

presentmentCurrency

ISO 4217 Currency Code of this transaction at presentment; defaults to USD if not specified.

divisionNumber

The merchant's division or group with their payment provider, which this transaction is associated with. Paymentech refers to this as the division number, Litle as the report group, etc.

reasonCode

The merchant-bank reported reason code for the chargeback

caseNumber

The merchant-bank reported case number for the chargeback

referenceNumber

The merchant-bank reported referenceNumber for the chargeback

merchantNumber

The merchant-bank reported merchant number

merchantTransactionId

The merchant's transaction ID, as specified to Vindicia during a transaction-related call

merchantTransactionTimestamp

The merchant-reported timestamp of the transactio during a transaction-related calls

processorReceivedTimestamp

The time the merchant bank received the chargeback

postedTimestamp

Time the chargeback was posted; is the 'creation time' of the chargeback

statusChangedTimestamp

The time this status change ocurred

status

Status of the item. See ChargebackStatus for possible values

merchantUserId

Merchant's user ID for this chargeback

note

Any notes on the chargeback

nameValues

Optional array of name/value pairs associated with a Chargeback

Details for a CreditCard.

account

The full account number. For non-CashBox methods (e.g., Transaction::score), this field must be left blank. The precise form used here will vary with the exact payment method, but in general, Vindicia does not validate accounts algorithmically. If validation of an account is desired, it should be handled either by calling link=validate or by setting the appropriate PaymentMethodUpdateOperation value on a link=update call. Full account number is required if a transaction is to be processed through Vindicia. If a transaction is being simply reported to Vindicia for chargeback fighting, you may provide, for example, account hash instead

bin

The Bank Identification Number, i.e., the first six digits. If the account field is provided, this may be left blank and it will be filled in by Vindicia.

lastDigits

The last part of the account number for display purposes, generally the last four digits. If the account field is provided, this may be left blank and it will be filled in by Vindicia.

accountLength

Length of the total account number. If the full account number is submitted, this field may be left blank; Vindicia will calculate it.

hashType

The algorithm used for hashing the account number. If this value is not provided we assume SHA1

accountHash

A hash of the full account number. Any non-numeric characters should be removed prior to hashing. If the account number is provided, this may be left blank and the hash will be calculated by Vindicia. The exact length and format of this string may depend upon the hash algorithm chosen. Currently this value is not returned (i.e. is null) when you fetch this object from Vindicia e.g. via fetched transactions

expirationDate

Expiration date of the credit card. Should be formatted as YYYYMM. For example, July, 2008 should be sent as 200807. No validation is performed to check that this date is in the future.

Details for a DirectDebit account.

account

The full account number, generally a bank account number. For non-CashBox methods (e.g., Transaction::score), this field must be left blank. The precise form used here will vary with the exact payment method, but in general, Vindicia does not validate accounts algorithmically. If validation of an account is desired, it should be handled either by calling link=validate or by setting the appropriate PaymentMethodUpdateOperation value on a link=update call.

lastDigits

The last part of the account number for display purposes, generally the last four digits. If the account field is provided, this may be left blank and it will be filled in by Vindicia.

accountLength

Length of the total account number. If the full account number is submitted, this field may be left blank; Vindicia will calculate it.

hashType

The algorithm used for hashing the account number. If this value is not provided we assume SHA1

accountHash

A hash of the full account number. Any non-numeric characters should be removed prior to hashing. If the account number is provided, this may be left blank and the hash will be calculated by Vindicia. The exact length and format of this string may depend upon the hash algorithm chosen.

countryCode

The country code for a DirectDebit account

bankSortCode

The bank sort code for an DirectDebit account

ribCode

The RIB code for an DirectDebit account (France only)

Details for an ECP account.

account

The full account number, generally a bank account number. For non-CashBox methods (e.g., Transaction::score), this field must be left blank. The precise form used here will vary with the exact payment method, but in general, Vindicia does not validate accounts algorithmically. If validation of an account is desired, it should be handled either by calling link=validate or by setting the appropriate PaymentMethodUpdateOperation value on a link=update call.

hashType

The algorithm used for hashing the account number. If this value is not provided we assume SHA1

accountHash

A hash of the full account number. Any non-numeric characters should be removed prior to hashing. If the account number is provided, this may be left blank and the hash will be calculated by Vindicia. The exact length and format of this string may depend upon the hash algorithm chosen.

routingNumber

The routing number for an ACH/ECP account

accountType

The account type for an ACH/ECP account

lastDigits

The last part of the account number for display purposes, generally the last four digits. If the account field is provided, this may be left blank and it will be filled in by Vindicia.

accountLength

Length of the total account number. If the full account number is submitted, this field may be left blank; Vindicia will calculate it.

allowedTransactionType

Allowed type(s) of transactions for this PaymentMethod, e.g., Inbound, Outbound. Defaults to 'All.'

An electronic signature.

VID

Vindicia's Globally Unique Identifier (GUID) for this object

uri

URI of the document being signed

sourceIp

Source IP this transaction came from

timestamp

Time the signature is made

account

User who is being asked to sign

transaction

The transaction associated with this signature event

description

Text description of the signature

Template of an email

vid

Vindicia's Globally Unique Identifier (GUID) for this object

product

product this template refers to; if empty, is the merchant's default

templateType

Defines situation in which this EmailTemplate should be used

version

The version of this EmailTemplate. The format is 'X.x' where X is the major version and x is the minor version. Vindicia automatically increments the minor version every time you call update. All previous versions are archived.

from

The address from which this EmailTemplate should be sent

replyTo

The address to which this EmailTemplate should be replied

htmlMessage

Message to use for those who prefer HTML

textMessage

Message to use for those who prefer plaintext

Describes access by an Account to a given aspect of a Product

merchantEntitlementId

The merchant's unique ID of this entitlement

account

Account that owns this entitlement

startTimestamp

Time this entitlement begins

endTimestamp

Time this entitlement ends

active

Is this entitlement active or expired? Convenient shorthand for, 'Is today between the startTimestamp and the endTimestamp.'

An id/description pair describing merchant defined ids that indicate entitlement for specific product features.

id

The unique, merchant-defined id of this entitlement. Free-form string of 1024 or fewer bytes.

description

The merchant-defined description of this entitlement. Free-form string of 1024 or fewer bytes.

Metric on a class of statistic.

type

The type of transaction covered by these statistics.

numTransactions

The number of transactions covered in this report

minMs

The minimum number of milliseconds necessary to complete a transaction in this group.

maxMs

The maximum number of milliseconds necessary to complete a transaction in this group.

avgMs

The average number of milliseconds necessary to complete a transaction in this group.

A name/value pair describing attributes not otherwise supported in the object.

name

The name of the name/value pair (e.g., VendorID)

value

The value of the name/value pair (e.g., 12345)

Details for a PayPal account.

emailAddress

The email address for a PayPal account

hashType

The algorithm used for hashing the account number. If this value is not provided we assume SHA1

passwordHash

A hash of the password. If the password is provided, this may be left blank and the hash will be calculated by Vindicia. The exact length and format of this string may depend upon the hash algorithm chosen.

returnUrl

Cancel_URL for PayPal ExpressCheckout failure redirect

cancelUrl

Return_URL for PayPal ExpressCheckout success redirect

password

The password for a PayPal account

A payment method, e.g., credit card, PayPal, ECP, direct debit.

VID

Vindicia's Globally Unique Identifier (GUID) for this object. If one is not specified, one will be assigned.

type

Type of payment method this object represents. This must be specified and depending on the value of this attribute the corresponding payment method details object must be populated. For example, if the value of this attribute is CreditCard, the creditCard attribute must be populated.

creditCard

The credit card details for a PaymentMethod of type CreditCard.

ecp

The ECP account details for a PaymentMethod of type ECP.

directDebit

The direct debit account details for a PaymentMethod of type DirectDebit.

paypal

The PayPal account details for a PaymentMethod of type PayPal.

boleto

Details for a Boleto Bancario payment

token

Details of payment via tokens

nameValues

An optional array of name-value pair items specific to this payment method type. For example, for a credit card, name 'CVN' and value of '123' might be supplied. At this time, the name 'CVN' (the generic name for VISA CVV2 or MasterCard CVC) is the only supported name/value pair.

accountHolderName

Name of the account holder. This is a free-form string of 255 characters or less.

billingAddress

The billing address associated with this payment method, if any.

customerSpecifiedType

The customer-specified type of this card, if any. This is a free-form string of 64 or fewer characters and generally is going to be something like 'Visa'.

customerDescription

The name the customer gives this payment method, if any. This is a freeform string of 512 or fewer bytes. For example, 'Work MasterCard'.

merchantPaymentMethodId

The merchant's optional unique ID for this payment method. This is a free-form, unique string of 1024 or fewer bytes.

currency

ISO 4217 Currency Code to use if validation is required; defaults to USD

sortOrder

If this PaymentMethod is to be associated with an link=account, this is the index into the paymentMethods array at which this PaymentMethod should be inserted (see Account). If there is already a PaymentMethod at that index (e.g., sortOrder = 2 and the account already has three payment methods), this PaymentMethod will be inserted at index 2, and all others will be moved down the array. If not specified, the PaymentMethod will be added to the end of the array.

active

If true, this PaymentMethod will be included in the list of PaymentMethods for the associated Account (if there is one). Defaults to true.

A payment provider (i.e., a bank)

VID

Vindicia's Globally Unique Identifier (GUID) for this object

description

Description of the provider

paymentType

Type of payments accepted by this provider, as enumerated in PaymentMethodType.

account

Merchant's account identifier with this provider

A unique merchant product, with unique price, description and optional autobilling information.

VID

Vindicia's Globally Unique Identifier (GUID) for this object. If not specified, will be created.

merchantProductId

Merchant's unique ID for this item (e.g., SKU). Common forms include a database ID or string. This is a free-form string of 256 or fewer bytes.

description

Description of this item. This is a free-form string of 256 or fewer characters.

status

Status of message as enumerated in ProductStatus. For a new object, should generally be 'New' or blank.

taxClassification

Product type for tax purposes as enumerated in TaxClassification.

defaultBillingPlan

Optional default billing plan that can be used by the AutoBill if none is specified. Useful for merchants who have a single price plan for each Product. Merchants who have multiple pricing plans for each Product will need to associate a BillingPlan when creating an AutoBill.

endOfLifeTimestamp

Time at which product will go to end of life; i.e., when mandatory upgrade messaging begins. After this timestamp no more renewals will be allowed. If undefined, this Product is not in end of life and may be renewed.

nameValues

Optional array of name/value pairs the merchant wishes to associate with a Product

merchantEntitlementIds

Optional array of merchant defined ids that indicate entitlement for specific product features. Allows merchant to ask the question, 'Is Account X allowed to access Feature Y?' If not specified, this product provides no entitlements.

billingStatementIdentifier

Optional string that should be displayed on a customer's billing statement when they are charged. Please note that this value is probably constrained by the payment processor, and this should be be used with consulting with Vindicia Engineering.

tokensGranted

An array of Token objects granted to this account when this product is purchased

tokenPrice

The cost of this product in tokens (if any). This attribute is not currently supported and will be removed in a future version

Describes a refund. Refunds fall into two basic categories - merchant-processed and Vindicia-processed. In the former (often ChargeGuard) application, historic refunds are reported to Vindicia. In the latter, a refund is submitted to Vindicia for processing.

VID

Vindicia's Globally Unique Identifier (GUID) for this object. For new refunds, or historic refunds being reported the first time, this may be left blank upon submission and a VID will be generated by Vindicia.

merchantRefundId

Id of the refund. In a refund-performance environment, this field should be left blank on submission, but will be filled out on return. This is a free-form string of 255 or fewer characters.

transaction

The transaction the refund applies to. The most important piece of information for actually processing the refund is, in order of preference, the Transaction.VID followed by the Tranasaction.merchantTransactionId. One of these values must be present and link to an existing, actual transaction for an actual refund to occur.

amount

Amount of the refund. Must be positive, non-zero, and less than or equal to the entire amount of the original transaction in a refund-perfomance application; may be an arbitrary amount if reporting a historic merchant-processed refund.

currency

ISO 4217 Currency Code of this transaction; defaults to USD. In a refund-perormance application, this value is ignored and the currency value from the original transaction is used in preference.

timestamp

Time of the refund. In a refund-performance environment, it may be left blank, and will be automatically filled out.

referenceString

Any data returned from the payment method processor pertaining the refund (e.g., a refund ID). In a refund-performance environment, this field should be left blank on submission, but will be filled out on return. This is a free-form string of 255 or fewer characters, and its values vary depending on the payment processor used.

note

Any notes about the refund, such as why it occurred. This is a free-form, 32KB string.

tokenAction

The action to take on Tokens relating to this transaction. If not specified, defaults to 'None'.

All methods return this class, which provides information on the result of an operation. See Return for complete documentation.

returnCode

returnString

soapId

Description of a sales tax to be charged

description

A 256-char maximum free-form string describing the type of sales tax (e.g., 'CA ESD Sales Tax'

tax

Tax to be charged

The rule hit by a specific score call

description

String description of the rule, such as PRIOR_CB_IN_VERTICAL

id

Integer ID of the rule, such as 1

Describes an exemption to a tax

region

Region the exemption applies to

exemptionId

ID that documents the exemption. E.g., a VAT ID, or a US Tax ID.

active

If true, this exemption is active.

A type of token. For many merchants, there will only be one of these. A token type might be 'gold pieces' or 'cell phone minutes' or 'downloads'.

VID

Vindicia's Globally Unique Identifier (GUID) for this object

merchantTokenId

A merchant's unique identifier for this token type

description

Description of this token type

A quantity of tokens in a particular type

token

The type of token this quantity describes

amount

The quantity of tokens.

A particular transaction using tokens

account

The (customer) account these tokens are to be deducted from. For now this object should be the same Account object on which tokenTransaction call is being made. This attribute is deprecated and will be removed in a future version.

tokenAmount

The quantity being deducted

description

Description of this transaction

authTimestamp

Timestamp the transaction ocurred on the merchant's system

clearedTimestamp

Timestamp the transaction was processed on Vindicia's system

Describes a transaction. Transactions come in two basic flavors: Merchant-processed and Vindicia-processed. Merchant-processed transactions have their processing done at the merchant, then are reported to Vindicia for achival purposes, generally as part of the ChargeGuard product. Vindicia-processed transaction are created as part of a CashBox system. Depending on the basic design of the system, these transactions may be created by the merchant for direct authentication through Vindicia (similar to a traditional payment gateway) or created by Vindicia based upon link=AutoBill records.

VID

Vindicia's Globally Unique Identifier (GUID) for this object. This field is created by Vindicia and is provided for merchants who don't track their own internal IDs on transactions to have a unique handle to track by. Generally speaking it may be safely ignored in favor of the merchantTransactionId at the merchant's preference. This is a 40-character freeform string.

amount

Amount of the transaction, as a decimal. Must be positive, but zero is allowed (though specific behavior of zero-amount transactions may vary on a processor by processor basis - if you think you have a need for this functionality, please discuss with Vindicia Engineering, before using). When you are simply reporting a transaction to Vindicia for ChargeGuard, this should add up to the total value of the all the link=TransactionItems associated, though no validation is performend to enforce this. However, if this transaction is billed through Vindicia, the amount will be calculated by adding up the prices on transaction (line) TransactionItem items. If the total of the line items evaluates to a negative value, the absolute value of the total will be used here.

currency

ISO 4217 Currency Code of this transaction; defaults to USD if not specified.

divisionNumber

The merchant's division or group with their payment processor, which this transaction is associated with. PaymenTech refers to this as the division number, Litle as the report group, etc.

merchantTransactionId

The merchant's unique ID for this transaction. If not specified, this transaction may only be referred to in the future by its VID. For transactions created by Vindicia from link=AutoBill records, this field will be filled in by Vindicia. For other records, this is generally the merchant's invoice number or other unique identifier for a specific transaction. This is stored as a free-form string with no validation and a maximum length of 128 characters. Generally speaking attempting to submit further data on an already used merchantTransactionId will have the effect of updating the previous transaction, as this is a unique key in the Vindicia system.

previousMerchantTransactionId

Merchant transaction ID for a previous transaction this transaction references. Use only if not submitting any PaymentMethod information with this transaction. This is intended for a very specific application with merchants who store absolutely no credit card information but do have pointers back to previously submitted transactions. It is not used for CashBox and may safely be ignored in that environment.

timestamp

Time this transaction ocurred. For Vindicia-processed transactions that are submitted for auth, it may be left blank and will be filled out by Vindicia.

account

The Account (i.e., Customer) account associated with this transaction.

sourcePaymentMethod

The PaymentMethod (e.g., a credit card) that funds were deducted from 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.

destPaymentMethod

The PaymentMethod (e.g., a credit card) that funds were deposited to for this transaction. In the case of a CashBox transaction, this payment method will be used to perfom the actual deposit. Note - most merchants will not want to ever fill this field out; this is used for ECP/ACH outbound payments (merchant paying out) and transfers, for example.

ecpTransactionType

The type of transaction, e.g., inbound, outbound. For use with Transactions using an ECP account.Set value of this attribute to Outbound if you have set destination payment method in your CashBox transaction and wish to conduct an outbound (customer gets paid rather than merchant) ECP/ACH transaction

statusLog

A log of various TransactionStatus entries associated with this transaction. In the case of transactions being submitted to Vindicia for processing in a CashBox environment, this should generally have only one status entry that indicates 'New' status or is empty, and Vindicia will fill in the correct new status upon return from the call. In a ChargeGuard environment, this should have entries set to the appropriate current status of the transaction.

paymentProcessor

The payment processor used for processing this transaction. This value will be filled in by Vindicia when the transaction is processed via Vindicia.

sourcePhoneNumber

Source phone number this transaction came from. Generally empty in Internet applications.

shippingAddress

Address shipping address associated with this transaction, if any. No shipping address is required to be specified for CashBox transactions, but it may be helpful for fraud prevention. If sales tax is to be calculated on this transaction, this item is required.

nameValues

Optional array of name/value pairs the merchant wishes to associate with a Transaction

transactionItems

TransactionItem array to list the individual line-items that make up this larger transaction. No validation is performed at this time to ensure that the sub-item amounts here add up to the total of the transaction; these items should be considered purely documentary. If sales tax or use tax is calculated by the merchant, that should be included here, as well. If it is calculated by Vindicia, it will be added as a line item on the transaction by Vindicia.

merchantAffiliateId

Merchant's ID for the affiliate that submitted this transaction, if any. This is a free-form string of 128 characters or less.

merchantAffiliateSubId

Merchant's sub-ID for the affiliate that submitted this transaction. Allows for finer tracking of affiliate programs. This is a free-form string of 128 characters or less.

userAgent

Customer's user-agent string for the transaction, as presented by the browser. This is for informational purposes only.

note

Free-form text notes that describe this transaction, if any

preferredNotificationLanguage

Language to be used in the email notification, specified as an ISO language string. The email notification will be sent this is a one time transaction initiated by a merchant and processed by Vindicia, and if a template for this language and the email notification type is uploaded in Vindicia database as a part of merchant configuration. Value of this attribute will override any language setting on the customer account associated with the transaction.

sourceMacAddress

MAC address of the customer (primarily intended for ISP usage), may be left blank if unavailable or inappropriate

sourceIp

Source IP this transaction came from (the end customer's, not the merchant's). Of the standard dotted-quad form. Useful in fraud prevention. Generally speaking, for most applications, it is expected to have one of sourceMacAddress, sourcePhone or sourceIp.

billingStatementIdentifier

The string that should be displayed on a customer's billing statement when charged. Please note that this value is probably constrained by the Payment Provider and should not be used without first consulting with Vindicia engineering.

taxExemptions

Exemptions that apply to this transaction

salesTaxAddress

Address corrected billing or shipping address actually used in calculation of sales tax on this transaction by Vindicia. This field is populated by Vindicia and is not expected to be filled by merchants. You can expect this field to be populated only if sales tax calculation is enabled for your merchant account with Vindicia

verificationCode

Response from other verification system for this transaction (e.g., Verified by Visa (VbV) or MasterCard SecureCode). This is usually used by merchants who simply report transactions to Vindicia.

A line-item in a Transaction. For example, a good sold, or sales tax, etc. All line-items added together should add up to the total transaction amount, though no enforcement of that is performed at this time.

sku

The merchant's tracking key for this item - the merchant's unique identifier for the product or service purchased. This is a free-form string of 256 or fewer characters.

name

A description of the item. This is a free-form string of 256 or fewer characters.

price

Price of the item, in the currency of the overall transaction. Currencies may not be mixed on a single transaction. This value must be zero or positive.

quantity

The number of items sold. If that is nonsensical (e.g., for sales tax) simply use '1'

taxClassification

Product type for tax purposes as enumerated in TaxClassification.

tokens

Tokens granted to the account on this transaction for purchasing this item

Reports the current status for a transaction.

status

The type of report, as specified by the enumerated type TransactionStatusType

timestamp

The time of the status change.

paymentMethodType

Type of the payment used for this transaction. Based on this you should check more details in one of the status detail objects

creditCardStatus

Status details for a credit card based transaction

ecpStatus

Status details for an ECP - Electronic Check Processing transaction

boletoStatus

Status details for a Boleto Bancario transaction

payPalStatus

Status details for a PayPal transaction - place holder for future implementation

directDebitStatus

Status details for a DirectDebit transaction - place holder for future implementation

vinAVS

Indicates status of AVS (address verification) as a simple string. Requires AVS be enabled with the payment processor

Boleto Bancario transaction status related information

uri

The URL returned by the payment processor in response to presentment of fiscal number. This should be displayed to the customer for further processing of the Boleto Bancario payment method based transaction

Status details for a credit card based transaction.

authCode

Result code for the status update. In the case of auth, capture, and authCapture this should be the code returned by the payment processor. In the case of cancellations, it should be the reason code returned by the payment processor if that is the cause of the cancellation, or -1 if the decision to cancel was made by you or the customer.

avsCode

AVS response code. When reporting a transaction, if you receive the AVS code as a string along with its authorization code (ie Y:2341234234 or Y-2341234234) just copy it into this field. If you receive the AVS code separate from its authorization code you should concatenate them with a colon as a separator as in the first example.

cvnCode

CVN response code. When reporting a transaction, if you receive the CVN code as a string along with its authorization code (ie M:2341234234 or M-2341234234) just copy it into this field. If you receive the CVN code separate from its authorization code you should concatenate them with a colon as a separator as in the first example.

DirectDebit transaction status related information - place holder for future implementation. The object might change in future.

authCode

Result code for the status update. This is a place holder for future implementation

ECP transaction status related information

authCode

Result code for the status update. In the case of auth, capture, and authCapture this is the reason code returned by the payment processor. In the case of cancellations, it is the reason code returned by the payment processor if that is the cause of the cancellation, or -1 if the decision to cancel was made by you or the customer.

Paypal transaction status related information - place holder for future implementation. The object might change in future.

token

Token for forPayPal ExpressCheckout

authCode

Result code for the status update. This is a place holder for future implementation

The preference of an account to receive text or HTML emails

Action to take on payment method update

Enumeration of the known types of initiators for cancellation activities

Enumeration of the known types of activities

Enumeration of the types of call an Activity describes

Status of this particular autobill item

What to do if the exact same object is submitted twice with no VID to reference it

Unit of time a period describes

Whether the BillingPlan is active, or not. Inactive BillingPlans may not be autobill-renewed.

Defines the situation in which an EmailTemplate should be used

The type of stat reported in a MetricStatistics object. Note that TimedOut objects are only for objects in which a connection is made, but the transaction is not completed. If connection is not possible, the failure counter should be incremented, instead.

The type of a given payment method

Type of hash algorithm

Type of bank account, for ECP accounts

Types of transactions for ECP accounts. Used for setting both the type of a Transaction and the allowed transaction types for a PaymentMethod.

Whether the product is active, or not. Inactive products may not be autobill-renewed.

Whether the product is taxable(generally or per jurisdiction) or not

The action taken on a refund of a transaction that caused a customer to be granted or to received tokens

Return codes for Vindicia applications. For all codes above 400, all data submitted should be assumed not received and must be resubmitted.

200

The request succeeded.

400

The client issued a request the server is not able to fufill, because the request is erroneous, nonsensical or generated a "reasonable" error. Specific information will be included in the returnString. Resubmitting the request unaltered will result in the same error. A "reasonable" error is one which is not caused by a programming error, but might be an error condition generated by user input that a well-crafted program will detect and handle.

403

Forbidden. The requested operation is forbidden under the currently provided credentials. Specific information may or may not be available in the returnString depending on specific security situations.

404

The requested item was not found.

500

The server was unable to fufill your request. This indicates either that the server was utterly unable to understand your request, or (more likely) that the server has an error. Any returnCodes of 500 or above should be considered high priority Vindicia errors and should be reported to your service representative at your earliest convenience. It is not generally anticipated that resubmitting will solve this error.

503

Service Unavailable. Indiciates that the requested service is currently unavailable (due, for example, to load or maintenence). Resubmitting at a later date should remove this error.

Region a tax applies to