Skip to main content
Vindicia Knowledge Center

AllDataTypes

Methods        

getVindicia http://soap.vindicia.com/v16_0/Vindicia#getVindicia

Input (Vindicia)
Name Type
AVSMatchType AVSMatchType
Account Account
AccountPayerReplacementBehavior AccountPayerReplacementBehavior
AccountType AccountType
AccountUpdate AccountUpdate
AccountUpdatePaymentMethod AccountUpdatePaymentMethod
Activity Activity
ActivityCallType ActivityCallType
ActivityCancelInitType ActivityCancelInitType
ActivityCancellation ActivityCancellation
ActivityEmailContact ActivityEmailContact
ActivityFulfillment ActivityFulfillment
ActivityLogin ActivityLogin
ActivityLogout ActivityLogout
ActivityNamedValue ActivityNamedValue
ActivityNote ActivityNote
ActivityPhoneContact ActivityPhoneContact
ActivityType ActivityType
ActivityTypeArg ActivityTypeArg
ActivityURIView ActivityURIView
ActivityUsage ActivityUsage
Address Address
AddressType AddressType
Amazon Amazon
ApplePay ApplePay
Authentication Authentication
AutoBill AutoBill
AutoBillItem AutoBillItem
AutoBillItemHistoryRecord AutoBillItemHistoryRecord
AutoBillItemModification AutoBillItemModification
AutoBillModificationAction AutoBillModificationAction
AutoBillStatus AutoBillStatus
AutoBillUpdate AutoBillUpdate
AutoBillUpgradeHistoryStep AutoBillUpgradeHistoryStep
AvsCvnPolicyStatus AvsCvnPolicyStatus
BilledStatus BilledStatus
BillingPeriodType BillingPeriodType
BillingPlan BillingPlan
BillingPlanHistoryRecord BillingPlanHistoryRecord
BillingPlanPeriod BillingPlanPeriod
BillingPlanPrice BillingPlanPrice
BillingPlanStatus BillingPlanStatus
BillingState BillingState
Boleto Boleto
Campaign Campaign
CampaignRedemption CampaignRedemption
CampaignState CampaignState
CampaignTimeGrant CampaignTimeGrant
CampaignTimeGrantLengthType CampaignTimeGrantLengthType
CampaignType CampaignType
CancelReason CancelReason
CancelResult CancelResult
CaptureResult CaptureResult
CarrierBilling CarrierBilling
ChargeCustomer ChargeCustomer
Chargeback Chargeback
ChargebackStatus ChargebackStatus
CouponCode CouponCode
CouponCodeState CouponCodeState
CouponRedeemedBy CouponRedeemedBy
Credit Credit
CreditCard CreditCard
CreditEventLog CreditEventLog
CreditEventType CreditEventType
CurrencyAmount CurrencyAmount
Diagnostic Diagnostic
DirectDebit DirectDebit
DuplicateBehavior DuplicateBehavior
DynamicPriceMode DynamicPriceMode
ECP ECP
ECPTransactionType ECPTransactionType
ElectronicSignature ElectronicSignature
EmailPreference EmailPreference
EmailTemplate EmailTemplate
EmailTemplateType EmailTemplateType
Entitlement Entitlement
Event Event
EventRecordMethod EventRecordMethod
ExtendedCardAttributes ExtendedCardAttributes
GiftCard GiftCard
GiftCardActivityType GiftCardActivityType
GiftCardStatus GiftCardStatus
GiftCardStatusType GiftCardStatusType
HashType HashType
HostedPage HostedPage
ImmediateAuthFailurePolicy ImmediateAuthFailurePolicy
InvoiceStates InvoiceStates
Mandate Mandate
MandateStatus MandateStatus
MerchantAcceptedPayment MerchantAcceptedPayment
MerchantEntitlementId MerchantEntitlementId
MigrationTaxItem MigrationTaxItem
MigrationTransaction MigrationTransaction
MigrationTransactionItem MigrationTransactionItem
MigrationTransactionItemType MigrationTransactionItemType
MigrationTransactionType MigrationTransactionType
MultiplyRatedUnitsBy MultiplyRatedUnitsBy
NameValuePair NameValuePair
PayPal PayPal
PaymentDetails PaymentDetails
PaymentMethod PaymentMethod
PaymentMethodType PaymentMethodType
PaymentMethodUpdate PaymentMethodUpdate
PaymentMethodValidate PaymentMethodValidate
PaymentOverageDisposition PaymentOverageDisposition
PaymentProvider PaymentProvider
PaymentUpdateBehavior PaymentUpdateBehavior
PhoneNumber PhoneNumber
PhoneType PhoneType
PriceCriteria PriceCriteria
PricePointDeviationPolicy PricePointDeviationPolicy
Product Product
ProductDescription ProductDescription
ProductPrice ProductPrice
ProductStatus ProductStatus
PromotionPeriodLengthType PromotionPeriodLengthType
PromotionType PromotionType
RatePlan RatePlan
RatePlanModel RatePlanModel
RatePlanPrice RatePlanPrice
RatePlanStatus RatePlanStatus
RatePlanTier RatePlanTier
RatedUnit RatedUnit
RatedUnitSummary RatedUnitSummary
Refund Refund
RefundItem RefundItem
RefundStatus RefundStatus
RefundTokenAction RefundTokenAction
Return Return
ReturnCode ReturnCode
SalesTax SalesTax
ScoreCode ScoreCode
Season Season
SeasonSet SeasonSet
Skrill Skrill
StatementFormat StatementFormat
TaxExemption TaxExemption
TaxItem TaxItem
TimeInterval TimeInterval
TimeIntervalType TimeIntervalType
Token Token
TokenAmount TokenAmount
TokenTransaction TokenTransaction
Transaction Transaction
TransactionAttemptSummary TransactionAttemptSummary
TransactionAuth TransactionAuth
TransactionAuthCapture TransactionAuthCapture
TransactionCampaignDiscount TransactionCampaignDiscount
TransactionItem TransactionItem
TransactionItemRefundSummary TransactionItemRefundSummary
TransactionItemType TransactionItemType
TransactionStatus TransactionStatus
TransactionStatusAmazon TransactionStatusAmazon
TransactionStatusApplePay TransactionStatusApplePay
TransactionStatusBoleto TransactionStatusBoleto
TransactionStatusCarrierBilling TransactionStatusCarrierBilling
TransactionStatusCreditCard TransactionStatusCreditCard
TransactionStatusDirectDebit TransactionStatusDirectDebit
TransactionStatusECP TransactionStatusECP
TransactionStatusHostedPage TransactionStatusHostedPage
TransactionStatusPayPal TransactionStatusPayPal
TransactionStatusSkrill TransactionStatusSkrill
TransactionStatusType TransactionStatusType
TransactionValidationResponse TransactionValidationResponse
WebSession WebSession
WebSessionMethodReturn WebSessionMethodReturn

 

 

Data Types

Account       Back to top

Member Name Type Min. Qty
VID xsd:string 0
merchantAccountId xsd:string 0
parentMerchantAccountId xsd:string 0
defaultCurrency xsd:string 0
emailAddress xsd:string 0
emailTypePreference EmailPreference 0
preferredLanguage xsd:string 0
warnBeforeAutobilling xsd:boolean 0
company xsd:string 0
name xsd:string 0
shippingAddress Address 0
paymentMethods PaymentMethod (0 or more) 0
nameValues NameValuePair (0 or more) 0
taxExemptions TaxExemption (0 or more) 0
tokenBalances TokenAmount (0 or more) 0
credit Credit 0
entitlements Entitlement (0 or more) 0
taxType xsd:string 0

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.
parentMerchantAccountId
A merchant's unique identifier for the parent account for this account. This is a free-form string of 128 or fewer characters.
defaultCurrency
The default 3 character currency code to use for this account. See the ISO 4217 standard for more details.
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 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.
credit
Credit(s) associated with the account
entitlements
Array of Entitlements associated with this Account. Note that account entitlement modifications must be made via Account methods such as grantEntitlement, revokeEntitlement, etc. Entitlement modifications made by other means (i.e. update), will be silently ignored.
taxType
Account-level code used with external tax system's rules for exemption behavior and custom tax handling

 

AccountUpdate       Back to top

Member Name Type Min. Qty
account Account 0
created xsd:boolean 0

Creates a new Account object or updates an existing one. You can't update Payment Methods using this call, Please see Account_UpdatePaymentMethod

account
The Account class object
created
True if the object was created new

 

AccountUpdatePaymentMethod       Back to top

Member Name Type Min. Qty
account Account 0
validated xsd:boolean 0

Creates a new payment method if necessary, and, if so specified, sets this payment method to replace all others on all of an account's autobills.

account
The account object
validated
True if the payment method was successfully validated

 

Activity       Back to top

Member Name Type Min. Qty
account Account 0
activityType ActivityType 1
activityArgs ActivityTypeArg 0
timestamp xsd:dateTime 1

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

 

ActivityCancellation       Back to top

Member Name Type Min. Qty
reason xsd:string 0
confirmationCode xsd:int 0
initiator ActivityCancelInitType 1

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

 

ActivityEmailContact       Back to top

Member Name Type Min. Qty
srcEmail xsd:string 0
destEmail xsd:string 0
note xsd:string 0

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

 

ActivityFulfillment       Back to top

Member Name Type Min. Qty
merchantTransactionId xsd:string 0
shipper xsd:string 0
trackingString xsd:string 0
shippingAddress Address 0
delivered xsd:boolean 0
receivedTs xsd:dateTime 0
receiptName xsd:string 0

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

 

ActivityLogin       Back to top

Member Name Type Min. Qty
ip xsd:string 0

Information about a login

ip
The IP the login came from

 

ActivityLogout       Back to top

Member Name Type Min. Qty
ip xsd:string 0

Information about a logout

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

 

ActivityNamedValue       Back to top

Member Name Type Min. Qty
type xsd:string 1
name xsd:string 1
value xsd:string 1

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

 

ActivityNote       Back to top

Member Name Type Min. Qty
note xsd:string 0

Information about a merchant customer

note
The note about a merchant customer

 

ActivityPhoneContact       Back to top

Member Name Type Min. Qty
srcPhoneNumber xsd:string 0
destPhoneNumber xsd:string 0
cidPhoneNumber xsd:string 0
aniPhoneNumber xsd:string 0
durationSeconds xsd:int 0
note xsd:string 0
type ActivityCallType 1

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

 

ActivityTypeArg       Back to top

Member Name Type Min. Qty
loginArgs ActivityLogin 0
logoutArgs ActivityLogout 0
uriviewArgs ActivityURIView 0
phoneArgs ActivityPhoneContact 0
emailArgs ActivityEmailContact 0
fulfillmentArgs ActivityFulfillment 0
usageArgs ActivityUsage 0
namedvalueArgs ActivityNamedValue 0
cancellationArgs ActivityCancellation 0
noteArgs ActivityNote 0

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.

 

ActivityURIView       Back to top

Member Name Type Min. Qty
ip xsd:string 0
uri xsd:anyURI 1
size xsd:int 0
bytesTransferred xsd:int 0
transferTime xsd:int 0
description xsd:string 1

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

 

ActivityUsage       Back to top

Member Name Type Min. Qty
description xsd:string 0
total xsd:int 0
lastDay xsd:int 0
lastWeek xsd:int 0
lastMonth xsd:int 0
lastYear xsd:int 0
lastUsageDate xsd:dateTime 0

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

 

Address       Back to top

Member Name Type Min. Qty
VID xsd:string 0
name xsd:string 0
addr1 xsd:string 0
addr2 xsd:string 0
addr3 xsd:string 0
city xsd:string 0
county xsd:string 0
district xsd:string 0
postalCode xsd:string 0
country xsd:string 0
phone xsd:string 0
fax xsd:string 0
latitude xsd:decimal 0
longitude xsd:decimal 0

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.

 

Amazon       Back to top

Member Name Type Min. Qty
billingAgreementId xsd:string 0
buyerName xsd:string 0
buyerEmail xsd:string 0
physicalAddress Address 0
billingAddress Address 0
addressVerificationCode xsd:string 0

Details for an Amazon account.

billingAgreementId
The Amazon billing agreement identifier. This value is returned by the OffAmazonPayments getAmazonBillingAgreementId API call and should be passed to Vindicia here.
buyerName
The name Amazon associates with the billing agreement identifier.
buyerEmail
The email Amazon associates with the billing agreement identifier.
physicalAddress
The address Amazon associates with the billing agreement identifier.
billingAddress
The billing address Amazon associates with the buyer's payment method.
addressVerificationCode
The address verification code Amazon received when validating the buyer's payment method.

 

ApplePay       Back to top

Member Name Type Min. Qty
paymentInstrumentName xsd:string 0
paymentNetwork xsd:string 0
transactionIdentifier xsd:string 0
paymentData xsd:string 0
expirationDate xsd:string 0

Details for an ApplePay payment.

paymentInstrumentName
The paymentInstrumentName field from PKPayment.
paymentNetwork
The paymentNetwork from PKPayment.
transactionIdentifier
The transactionIdentifier field from PKPayment.
paymentData
The paymentData field from PKPayment
expirationDate
Returnd the expiration date of the credit card used for ApplePay. Will be formatted as YYYYMM. For example, July, 2008 will be returned as 200807.

 

Authentication       Back to top

Member Name Type Min. Qty
version xsd:string 1
login xsd:string 1
password xsd:string 1
evid xsd:string 0
userAgent xsd:string 0

Authentication information for this request.

 

version
The version of the request. Current supported version is 16.0
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.

 

AutoBill       Back to top

Member Name Type Min. Qty
VID xsd:string 0
merchantAutoBillId xsd:string 0
account Account 0
billingPlan BillingPlan 0
paymentMethod PaymentMethod 0
currency xsd:string 0
customerAutoBillName xsd:string 0
status AutoBillStatus 0
billingState BillingState 0
startTimestamp xsd:dateTime 0
endTimestamp xsd:dateTime 0
items AutoBillItem (0 or more) 0
sourceIp xsd:string 0
billingStatementIdentifier xsd:string 0
billingDay xsd:int 0
minimumCommitment xsd:int 0
merchantAffiliateId xsd:string 0
merchantAffiliateSubId xsd:string 0
warnOnExpiration xsd:boolean 0
nextBilling Transaction 0
nameValues NameValuePair (0 or more) 0
credit Credit 0
statementFormat StatementFormat 0
invoiceTerms xsd:int 0
statementOffset xsd:int 0
statementTemplateId xsd:string 0
billingPlanCampaignCode xsd:string 0
billingPlanCampaignId xsd:string 0
mandate Mandate 0
cancelReason CancelReason 0

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 Product (to describe what is being purchased) an Account (to descibe who is purchasing it) and a 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.
billingPlan
The BillingPlan from which to create the AutoBillPeriods. 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 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 BillingPeriodPlan
customerAutoBillName
Customer-defined, optional name for this autobilling object (e.g, 'Home Subscription').
status
Status of AutoBilling as enumerated in AutoBillStatus. This is a read-only field.
billingState
 
startTimestamp
Time this autobilling begins. If not specified, defaults to the current time.
endTimestamp
The time till entitlements offered by this autobill should be considered valid. This timestamp should never be set by merchant. This attribute should be considered as read only attribute on AutoBill object returned by CashBox in response to a SOAP call. CashBox sets this timestamp based on last successful billing, cancellation, delaying and other actions performed against the AutoBill
items
Array of items (and associated Products) to be included in the AutoBill
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.
nextBilling
The next projected future billing for this AutoBill, if any. This is a read only attribute set by CashBox on AutoBill objects returned by a SOAP call and should not be set by a merchant
nameValues
An optional array of name-value pair items specific to this autobill. For example, for an autobill with a new payment method of type European Direct Debit , name 'vin:MandateFlag' and value '1' might be supplied as well as name 'vin:MandateVersion' and value '1.0.1'
credit
Credit(s) associated with the autobill
statementFormat
How to format billing statements sent to customer. Defaults to DoNotSend if not specified
invoiceTerms
Days after the invoice date that a bill is considered delinquent, if the AutoBill payment method is of type MerchantAcceptedPayment. The value will be ignored for conventionally-funded AutoBills
statementOffset
Days prior to billing that statement will be sent. This value must be null or 0 if the AutoBill is invoice-based. For conventionally-funded AutoBills, this value must be less than the prebilling notification days (if specified). The value will be ignored if statementFormat is DoNotSend
statementTemplateId
Merchant Identifier for pre-defined statement template. If this value is null (or does not match any pre-defined statement templates), the Vindicia-default template will be used.
billingPlanCampaignCode
Campaign code to redeem on this AutoBill against the price of BillingPlan. To apply a campaign, use this field to send in a valid coupon or promotion code.
billingPlanCampaignId
The unique identifier for a campaign applied to the price of the BillingPlan for this AutoBill. This is a read-only field returned by CashBox for informational purposes. Values sent in with a SOAP call are ignored.
mandate
The mandate authorizing this subscription
cancelReason
An object that contains the cancel reason code and description

 

AutoBillItem       Back to top

Member Name Type Min. Qty
merchantAutoBillItemId xsd:string 0
VID xsd:string 0
index xsd:int 0
product Product 0
amount xsd:decimal 0
currency xsd:string 0
ratePlan RatePlan 0
nameValues NameValuePair (0 or more) 0
quantity xsd:decimal 0
token Token 0
cycles xsd:int 0
cyclesRemaining xsd:int 0
addedDate xsd:dateTime 0
removedDate xsd:dateTime 0
startDate xsd:string 0
campaignCode xsd:string 0
campaignId xsd:string 0
transitionedFromMerchantAutoBillItemId xsd:string 0
transitionedToMerchantAutoBillItemId xsd:string 0
transitionedFromAutoBillItemVid xsd:string 0
transitionedToAutoBillItemVid xsd:string 0

An object which describes a Product included in an AutoBill as well as how to bill for this item

merchantAutoBillItemId
Optional merchant-supplied unique name for this AutoBillItem.
VID
Vindicia-supplied unique name for this AutoBillItem. When you first create an AutoBillItem, you should leave "VID" empty. Vindicia will fill it in for the items it returns through SOAP.
index
Index number of item in the "items" field of an AutoBill. (Should be unique in array. First item should have index 0)
product
The Product to be autobilled. When creating a new AutoBillItem 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 than implicitly.
amount
Amount to bill (regardless of Product price information).
currency
ISO 4217 currency code to be used for override amount. This value will be ignored if amount is null
ratePlan
Rate plan associated with this item, if it is a rated item.
nameValues
An optional array of name-value pair items specific to this autobill item.
quantity
Number of items. This number must be a whole number unless the item is a rated item.
token
Token associated with amount (if this is a Token-based autobill). This value will be ignored if amount is null
cycles
Number of billing cycles this item will be active. If null, the item will remain active until explicitly removed.
cyclesRemaining
Read-only field indicating how many billing cycles remain for this item.
addedDate
Read-only attribute indicating the time this item was added.
removedDate
Read-only attribute indicating the time this item was removed.
startDate
When should this item (i.e. Product) first be included in a billing? Can be null, yyyy-mm-dd, or a time interval like 3 days, 1 year, or 2 seasons.
campaignCode
Campaign code redeemed on this AutoBillItem. To apply a campaign, use this field to send in a valid coupon or promotion code.
campaignId
The unique identifier for a campaign applied to this item. This is a read-only field returned by CashBox for informational purposes. Values sent in with a SOAP call are ignored.
transitionedFromMerchantAutoBillItemId
The identifier of the AutoBillItem this item replaced as a result of an AutoBill::modify() call.
transitionedToMerchantAutoBillItemId
The identifier of the AutoBillItem that replaced this item as a result of an AutoBill::modify() call.
transitionedFromAutoBillItemVid
The unique Vindicia identifier of the AutoBillItem this item replaced as a result of an AutoBill::modify() call.
transitionedToAutoBillItemVid
The unique Vindicia identifier of the AutoBillItem that replaced this item as a result of an AutoBill::modify() call.

 

AutoBillItemHistoryRecord       Back to top

Member Name Type Min. Qty
action AutoBillModificationAction 0
actionDate xsd:dateTime 0
effectiveDate xsd:dateTime 0
autoBillItem AutoBillItem 0

A description of a change in an AutoBill

action
Action performed on the AutoBillItem.
actionDate
Date and time that the change was requested.
effectiveDate
Date and time that the action becomes effective on the AutoBillItem.
autoBillItem
The AutoBillItem as it was on the given date, after the given action was performed.

 

AutoBillItemModification       Back to top

Member Name Type Min. Qty
removeAutoBillItem AutoBillItem 0
addAutoBillItem AutoBillItem 0
editAutoBillItem AutoBillItem 0

A specification for a change in the AutoBillItems associated with an AutoBill.

removeAutoBillItem
An AutoBillItem to removed from the AutoBill. There must be sufficient information on this object to uniquely identify the item to be removed. Fields that may be used to identify the item are: VID, index, merchantAutoBillItemId, and Product.
addAutoBillItem
An AutoBillItem to add to the AutoBill. This must be a new item (e.g., there should be no VID).
editAutoBillItem
Fields to change on a given AutoBillItem.

 

AutoBillUpdate       Back to top

Member Name Type Min. Qty
autobill AutoBill 0
created xsd:boolean 0
authStatus TransactionStatus 0
score xsd:int 0
scoreCodes ScoreCode (0 or more) 0
initialTransaction Transaction 0

Creates a new AutoBill object or updates an existing one.

autobill
The resultant object
created
True if the object was created new
authStatus
If payment method validation was requested, this object will contain more information on response to the validation from the payment processor. You can examine this object for things such as Address Verification (AVS) response code, CVV response code, etc.
score
The score of the transaction based upon the information provided. Ranges from 0 (best) to 100 (worst). May also be -1, indicating that Vindicia has no opinion, or -2 indicating an error condition. -2 error transactions should be retried later in order to complete the transaction database for chargeback challenging. Further information about why a given score was returned is available in scoreCodes. If the transaction score is not acceptable, the score may be improved by presenting the information in scoreImprovements to the user and resubmitting a score call.
scoreCodes
Array containing strings that explain why the risk score came out be of a certain value
initialTransaction
For new AutoBills, this will be the initial Transaction for the subscription.

 

AutoBillUpgradeHistoryStep       Back to top

Member Name Type Min. Qty
vid xsd:string 0
startTimestamp xsd:dateTime 0
endTimestamp xsd:dateTime 0

A single step in the upgrade history of an AutoBill.

vid
Vindicia ID for the object
startTimestamp
Date and time this step began
endTimestamp
Date and time this step began -- will be omitted if this step is current

 

AvsCvnPolicyStatus       Back to top

Member Name Type Min. Qty
returnCode xsd:string 1
returnString xsd:string 0

Status details for the AVS and CVN policy evaluations.

returnCode
Result code for the AVS and CVN policy evaluations.
returnString
Result string for the AVS and CVN policy evaluations.

 

BillingPlan       Back to top

Member Name Type Min. Qty
VID xsd:string 0
merchantBillingPlanId xsd:string 0
description xsd:string 0
status BillingPlanStatus 0
taxClassification xsd:string 0
periods BillingPlanPeriod (0 or more) 0
prenotifyDays xsd:int 0
endOfLifeTimestamp xsd:dateTime 0
nameValues NameValuePair (0 or more) 0
merchantEntitlementIds MerchantEntitlementId (0 or more) 0
billingStatementIdentifier xsd:string 0
timesToRun xsd:string 0
entitlementsValidFor xsd:string 0
repeatEvery xsd:string 0
seasonSet SeasonSet 0
daysBeforeSeasonToBill xsd:int 0
daysEntitledBeforeSeason xsd:int 0
daysEntitledAfterSeason xsd:int 0
entitledOffSeason xsd:boolean 0
skipInitialFreeWhenRepeating xsd:boolean 0

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.
taxClassification
Billing Plan type for tax purposes as string.
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
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.
timesToRun
How many times to run the entire billing period set? Defaults to null. Can be either an integer or 'unlimited'.
entitlementsValidFor
When billing stops how long are the entitlements valid? - from the date of the first billing.
repeatEvery
If the billing period set is repeated how long after the first billing should we wait before repeating?
seasonSet
To which seasonSet does this Billing Plan apply? - can be NULL
daysBeforeSeasonToBill
If the billing period set is repeated in x seasons - how many days before the season should we restart the billing?
daysEntitledBeforeSeason
How many days before the next season are entitlements available?
daysEntitledAfterSeason
How many days after the next season are entitlements available?
entitledOffSeason
Are entitlements available in the off season? Default No
skipInitialFreeWhenRepeating
Should we skip initial free periods when repeating? Default Yes

 

BillingPlanHistoryRecord       Back to top

Member Name Type Min. Qty
merchantBillingPlanId xsd:string 0
startDate xsd:dateTime 0
endDate xsd:dateTime 0

A record of the period during which a BillingPlan was associated with this AutoBill.

merchantBillingPlanId
Identifier for the BillingPlan
startDate
Date the BillingPlan was first associated with the AutoBill.
endDate
Date the BillingPlan was removed from the AutoBill.

 

BillingPlanPeriod       Back to top

Member Name Type Min. Qty
type BillingPeriodType 0
quantity xsd:int 0
cycles xsd:int 0
prices BillingPlanPrice (0 or more) 0
expireWarningDays xsd:int 0
doNotNotifyFirstBill xsd:boolean 0
free xsd:boolean 0

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.
free
Set to true if this billing period should be free. BillingPlanPrice information for this period will be ignored if this is set to true.

 

BillingPlanPrice       Back to top

Member Name Type Min. Qty
amount xsd:decimal 0
currency xsd:string 0
priceListName xsd:string 0
tokenAmount TokenAmount 0

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

 

Boleto       Back to top

Member Name Type Min. Qty
fiscalNumber xsd:string 0

Details for a Boleto Bancario payment

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

 

Campaign       Back to top

Member Name Type Min. Qty
name xsd:string 0
description xsd:string 0
campaignId xsd:string 0
VID xsd:string 0
state CampaignState 0
offerStartDate xsd:dateTime 0
offerEndDate xsd:dateTime 0
campaignType CampaignType 0
flatAmountDiscount CurrencyAmount 0
percentageDiscount xsd:decimal 0
timeGrant CampaignTimeGrant 0
eligibleProducts Product (0 or more) 0
eligibleBillingPlans BillingPlan (0 or more) 0
restrictToNewSubscription xsd:boolean 0
note xsd:string 0
expirationDate xsd:dateTime 0
cycles xsd:integer 0
promotionCode xsd:string 0
promotionCodeAliases xsd:string (0 or more) 0
maxRedemptions xsd:integer 0
couponCodeQuantity xsd:integer 0
couponCodePrefix xsd:string 0
couponCodeSeparator xsd:string 0
couponCodeRequiresActivation xsd:boolean 0

Campaign object

name
Name of campaign
description
Description of campaign
campaignId
Unique identifier for campaign
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 campaignId if that is more appropriate for the merchant's application.
state
State of campaign.
offerStartDate
Date offer starts
offerEndDate
Date offer ends
campaignType
specifies what type of campaign this is, e.g. Coupon, Promo etc.
flatAmountDiscount
Flat amount discount, or discounts, as a (currency, amount) pairs see CurrencyAmount.
percentageDiscount
Discount, taken as a percentage. "flatAmountDiscount" and "percentageDiscount" are mutually exclusive.
timeGrant
Amount of free access obtained (by means of delaying billings.
eligibleProducts
1 or more eligible Products eligible for this Campaign.
eligibleBillingPlans
1 or more eligible BillingPlans eligible for this Campaign.
restrictToNewSubscription
Campaign offer only applies to new autobills, not existing ones.
note
 
expirationDate
Expiration date of a "Fixed" Campaign. "Rolling" Campaigns should leave this blank.
cycles
Number of times the campaign discount repeats, e.g. if you want to discount 3 cycles of a biweekly subscription, this would be 3.
promotionCode
The primary redemption code associated with this Promotion.
promotionCodeAliases
A list of alternative redemption codes for this Promotion. This will be treated as the complete list of aliases (i.e., it will replace the current list during an update, rather than only adding any new values).
maxRedemptions
The maximum number of redemptions per Coupon, where each (Account, Product) pair used counts as one redemption. If you want a Coupon that is only usable by one person, make this 1. It must be a positive integer.
couponCodeQuantity
Number of coupon codes to generate, total.
couponCodePrefix
String to use as the beginning of coupon codes generated for this coupon.
couponCodeSeparator
Character to use to separate sections of a coupon code, if desired.
couponCodeRequiresActivation
If true, each coupon code will require an individual activation by the merchant; the default is to activate all at once, when the Campaign is activated.

 

CampaignRedemption       Back to top

Member Name Type Min. Qty
campaignId xsd:string 0
couponSequenceNumber xsd:int 0

Minimal information necessary to track what Coupon or Promotion was used on an AutoBill, AutoBillItem or Transaction.

campaignId
 
couponSequenceNumber
For coupons, this will give the unique number of the particular coupon used; for promotions, this will be omitted

 

CampaignTimeGrant       Back to top

Member Name Type Min. Qty
quantity xsd:int 0
type CampaignTimeGrantLengthType 0

Campaign subobject to describe time grants

quantity
 
type
 

 

CancelReason       Back to top

Member Name Type Min. Qty
reason_code xsd:string 0
description xsd:string 0

Reason for cancelling the autobill

reason_code
A reason code assigned for the cancel
description
The reason of the cancel

 

CancelResult       Back to top

Member Name Type Min. Qty
returnCode xsd:int 1
merchantTransactionId xsd:string 1

.

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.

 

CaptureResult       Back to top

Member Name Type Min. Qty
returnCode xsd:int 1
merchantTransactionId xsd:string 1
originalMerchantTransactionId xsd:string 0

.

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.
originalMerchantTransactionId
Merchant transaction identifier for the original transaction, if a re-auth was done.

 

CarrierBilling       Back to top

Member Name Type Min. Qty
phoneNumber PhoneNumber 0
encodedPhoneNumber xsd:string 0
paymentProvider PaymentProvider 0
currency xsd:string 0
countryCode xsd:string 0
priceCriteria PriceCriteria 0

Details for a pay-by-mobile PaymentMethod.

phoneNumber
Phone number used for payment
encodedPhoneNumber
PaymentProvider-encoded phone number (readonly)
paymentProvider
PaymentProvider selected for Transaction. Currently only BOKU is supported.
currency
ISO 4217 Currency Code for for either the static_price_inc_salestax, or the dynamic_target_price (For dynamic pricing, the actual customer currency will be determined by the customer region/countryCode).
countryCode
ISO 3166-1 alpha-2 countryCode for customer location.
priceCriteria
PriceCirteria are used when stipulating dynamic pricing for a Transaction. Note that priceCriteria has no meaning (and will be ignored) when creating a new PaymentMethod for an Account. Therefore only include this subobject with the PaymentMethod when processing a CarrierBilling-funded Transaction.

 

Chargeback       Back to top

Member Name Type Min. Qty
VID xsd:string 0
amount xsd:decimal 1
currency xsd:string 0
presentmentAmount xsd:decimal 0
presentmentCurrency xsd:string 0
divisionNumber xsd:string 0
reasonCode xsd:string 1
caseNumber xsd:string 0
referenceNumber xsd:string 0
merchantNumber xsd:string 0
merchantTransactionId xsd:string 0
merchantTransactionTimestamp xsd:dateTime 0
processorReceivedTimestamp xsd:dateTime 1
postedTimestamp xsd:dateTime 1
statusChangedTimestamp xsd:dateTime 0
status ChargebackStatus 1
merchantUserId xsd:string 0
note xsd:string 0
nameValues NameValuePair (0 or more) 0

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

 

CouponCode       Back to top

Member Name Type Min. Qty
campaignId xsd:string 0
sequence xsd:int 0
code xsd:string 0
VID xsd:string 0
state CouponCodeState 0
redeemedBy CouponRedeemedBy (0 or more) 0
note xsd:string 0

CouponRedeemedBy       Back to top

Member Name Type Min. Qty
merchantAccountId xsd:string 0
accountVID xsd:string 0
date xsd:dateTime 0

Credit       Back to top

Member Name Type Min. Qty
tokenAmounts TokenAmount (0 or more) 0
timeIntervals TimeInterval (0 or more) 0
currencyAmounts CurrencyAmount (0 or more) 0

Credit Amounts.

tokenAmounts
An array of TokenAmount objects
timeIntervals
An array of TimeInterval objects
currencyAmounts
An array of CurrencyAmount objects

 

CreditCard       Back to top

Member Name Type Min. Qty
account xsd:string 0
bin xsd:string 0
lastDigits xsd:string 0
accountLength xsd:int 0
hashType HashType 0
accountHash xsd:string 0
expirationDate xsd:string 0
extendedCardAttributes ExtendedCardAttributes 0
VID xsd:string 0

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 validate or by setting the appropriate PaymentMethodUpdateOperation value on a 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.
extendedCardAttributes
Additional credit card details returned from Payment Provider
VID
Vindicia's Globally Unique Identifier (GUID) for this credit card.

 

CreditEventLog       Back to top

Member Name Type Min. Qty
credit Credit 0
timeStamp xsd:dateTime 0
type CreditEventType 0
note xsd:string 0

Ledger entry for a specific credit grant, revocation, etc.

credit
Credit granted, revoked, drawn during this event
timeStamp
Time when this credit event occured
type
Type of the credit activity. Should be used to decide whether this activity increments or decrements credit
note
Note regarding a credit granted/revoked

 

CurrencyAmount       Back to top

Member Name Type Min. Qty
currency xsd:string 0
amount xsd:decimal 1
nameValues NameValuePair (0 or more) 0
sortValue xsd:integer 0
description xsd:string 0
reason xsd:string 0
grantedByCashbox xsd:boolean 0
granted xsd:dateTime 0
VID xsd:string 0
accountVID xsd:string 0
merchantAccountId xsd:string 0
autoBillVID xsd:string 0
merchantAutoBillId xsd:string 0
source xsd:string 0

Currency Amount.

currency
ISO 4217 currency code to be used for this Currency Amount. Defaults to USD.
amount
Amount of the Currency Amount. Must be a positive value.
nameValues
An optional array of name-value pairs to associate with this currency credit.
sortValue
An arbitrary integer that affects where this credit appears in reports.
description
A description of the currency grant.
reason
The reason for the currency grant.
grantedByCashbox
Indicates if the currency credit was granted by CashBox.
granted
A timestamp that shows when the credit was granted.
VID
Vindicia's Globally Unique Identifier (GUID) for the credit.
accountVID
Vindicia's Globally Unique Identifier (GUID) for the account associated with this object.
merchantAccountId
The merchant's unique identifier for the account associated with this object.
autoBillVID
Vindicia's Globally Unique Identifier (GUID) for this object's AutoBill.
merchantAutoBillId
The merchant's unique identifier for the AutoBill associated with this object.
source
Describes the source of credit

 

Diagnostic       Back to top

Member Name Type Min. Qty
a_field xsd:string 0

Diagnostic interface object

a_field
Placeholder string

 

DirectDebit       Back to top

Member Name Type Min. Qty
account xsd:string 0
lastDigits xsd:string 0
accountLength xsd:int 0
hashType HashType 0
accountHash xsd:string 0
countryCode xsd:string 0
bankSortCode xsd:string 0
ribCode xsd:string 0

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 validate or by setting the appropriate PaymentMethodUpdateOperation value on a 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)

 

ECP       Back to top

Member Name Type Min. Qty
account xsd:string 0
hashType HashType 0
accountHash xsd:string 0
routingNumber xsd:string 0
accountType AccountType 0
lastDigits xsd:string 0
accountLength xsd:int 0
allowedTransactionType ECPTransactionType 0

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 validate or by setting the appropriate PaymentMethodUpdateOperation value on a 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.'

 

ElectronicSignature       Back to top

Member Name Type Min. Qty
VID xsd:string 0
uri xsd:anyURI 1
sourceIp xsd:string 0
timestamp xsd:dateTime 1
account Account 1
transaction Transaction 1
description xsd:string 0

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

 

EmailTemplate       Back to top

Member Name Type Min. Qty
vid xsd:string 0
product Product 1
templateType EmailTemplateType 0
version xsd:string 0
from xsd:string 0
replyTo xsd:string 0
htmlMessage xsd:string 0
textMessage xsd:string 0

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

 

Entitlement       Back to top

Member Name Type Min. Qty
merchantEntitlementId xsd:string 0
description xsd:string 0
merchantAutoBillId xsd:string 0
autoBillVID xsd:string 0
merchantProductId xsd:string 0
productVID xsd:string 0
account Account 0
startTimestamp xsd:dateTime 0
endTimestamp xsd:dateTime 0
active xsd:boolean 0

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

merchantEntitlementId
The merchant's unique ID of this entitlement
description
The merchant-defined description of this entitlement. Free-form string of 1024 or fewer bytes.
merchantAutoBillId
The merchant's AutoBill ID associated with this entitlement
autoBillVID
The AutoBill VID associated with this entitlement
merchantProductId
The merchant's Product ID associated with this entitlement
productVID
The Product VID associated with 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.'

 

Event       Back to top

Member Name Type Min. Qty
merchantEventId xsd:string 0
VID xsd:string 0
dateReceived xsd:dateTime 0
eventDate xsd:dateTime 0
description xsd:string 0
merchantAutoBillItemId xsd:string 0
autoBillItemVid xsd:string 0
merchantAccountId xsd:string 0
accountVid xsd:string 0
merchantAutoBillId xsd:string 0
autoBillVid xsd:string 0
merchantProductId xsd:string 0
productVid xsd:string 0
amount xsd:decimal 0
billedStatus BilledStatus 0
nameValues NameValuePair (0 or more) 0

A single rated event

merchantEventId
Merchant's unique name for this event. This field is optional for merchants, but if it is used, each event must have a unique name (for that merchant). If omitted, Vindicia will fill this field with a unique name.
VID
Vindicia's unique name for this event. This field is read-only.
dateReceived
Date/time that Vindicia received the event. Vindicia will fill this in.
eventDate
Date/time that the event was (or will be) considered billable. This date/time can be in the past, present or future. The default is to use the same date/time as "dateReceived".
description
Optional description of the event
merchantAutoBillItemId
Merchant's ID for the AutoBillItem that this event refers to. If this is omitted, some combination of autoBillItemVid, autoBillVid, merchantAutoBillId, productVid and merchantProductId must be used to uniquely specify the AutoBillItem.
autoBillItemVid
VID for the AutoBillItem that this event refers to. If this is omitted, some combination of merchantAutoBillItd, autoBillVid, merchantAutoBillId, productVid and merchantProductId must be used to uniquely specify the AutoBillItem.
merchantAccountId
If supplied by the merchant, we will use this to help identify which AutoBillItem the Event refers to. On events returned by Vindicia to the merchant, this will be the merchantAccountId for the corresponding Account.
accountVid
If supplied by the merchant, we will use this to help identify which AutoBillItem the Event refers to. On events returned by Vindicia to the merchant, this will be the VID for the corresponding Account.
merchantAutoBillId
If supplied by the merchant, we will use this to help identify which AutoBillItem the Event refers to. On events returned by Vindicia to the merchant, this will be the merchantAutoBillId for the corresponding AutoBill.
autoBillVid
If supplied by the merchant, we will use this to help identify which AutoBillItem the Event refers to. On events returned by Vindicia to the merchant, this will be the VID for the corresponding AutoBill.
merchantProductId
If supplied by the merchant, we will use this to help identify which AutoBillItem the Event refers to. On events returned by Vindicia to the merchant, this will be the merchantProductId for the corresponding Product.
productVid
If supplied by the merchant, we will use this to help identify which AutoBillItem the Event refers to. On events returned by Vindicia to the merchant, this will be the VID for the corresponding Product.
amount
The amount of RatedUnits used by this event. Fractional units are permitted.
billedStatus
This field is read-only; in returns from queries, Vindicia will use this field to tell whether the units in this event have been billed for or not.
nameValues
An optional array of name-value pair items specific to this event.

 

ExtendedCardAttributes       Back to top

Member Name Type Min. Qty
CommercialCard xsd:int 0
ConsumerCard xsd:int 0
CreditCard xsd:int 0
DebitCard xsd:int 0
SignatureDebitCard xsd:int 0
PINlessDebitCard xsd:int 0
GiftCard xsd:int 0
PrepaidCard xsd:int 0
PayrollCard xsd:int 0
HealthcareCard xsd:int 0
VirtualAccountNumber xsd:int 0
Reloadable xsd:int 0
CountryOfIssuance xsd:string 0
DurbinRegulated xsd:int 0
Affluent xsd:int 0
MassAffluent xsd:int 0
CardDescription xsd:string 0

Enhanced auth response details returned from Payment Provider.

CommercialCard
 
ConsumerCard
 
CreditCard
 
DebitCard
 
SignatureDebitCard
 
PINlessDebitCard
 
GiftCard
 
PrepaidCard
 
PayrollCard
 
HealthcareCard
 
VirtualAccountNumber
 
Reloadable
 
CountryOfIssuance
 
DurbinRegulated
 
Affluent
 
MassAffluent
 
CardDescription
 

 

GiftCard       Back to top

Member Name Type Min. Qty
sku xsd:string 0
pin xsd:string 0
lastDigits xsd:string 0
pinLength xsd:int 0
hashType HashType 0
pinHash xsd:string 0
paymentProvider xsd:string 0
status GiftCardStatus 0
VID xsd:string 0
product Product 0

A type of gift card. A gift card redemption would result in the granting of credits.

sku
Gift card SKU/UPC that defines the type of card
pin
PIN unique to each gift card that card holder enters in order to redeem the card
lastDigits
The last part of the PIN number for display purposes
pinLength
Length of the PIN. If the full PIN is submitted, this field may be left blank; Vindicia will calculate it.
hashType
The algorithm used for hashing the PIN. If this value is not provided we assume SHA1
pinHash
A hash of the full PIN. Any non-numeric characters should be removed prior to hashing. If the PIN 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
paymentProvider
Payment provider for gift card. Defaults to InComm
status
Current status of the gift card. Merchants should never set this. It will be set by Vindicia depending on operations conducted on this gift card.
VID
Vindicia's Globally Unique Identifier (GUID) for this object. If one is not specified, one will be assigned.
product
Product definition of the gift card specifying the credits granted by this gift card

 

GiftCardStatus       Back to top

Member Name Type Min. Qty
status GiftCardStatusType 0
timestamp xsd:dateTime 0
providerResponseCode xsd:string 0
providerResponseMsg xsd:string 0
nameValues NameValuePair (0 or more) 0

Reports the current status for a GiftCard (/activity).

status
The status type, as specified by the enumerated type GiftCardStatusType
timestamp
The time of the status change.
providerResponseCode
Payment provider response code to the activity/card
providerResponseMsg
Payment provider response message to the activity/card
nameValues
Optional array of name/value pairs associated with the activity/card

 

HostedPage       Back to top

Member Name Type Min. Qty
paymentProvider PaymentProvider 1
countryCode xsd:string 1
returnUrl xsd:string 0
language xsd:string 0
processorPaymentMethodId xsd:string 0
billingAgreementId xsd:string 0

Details for a HostedPage account.

paymentProvider
PaymentProvider selected for Transaction. Currently only Global Collect is supported.
countryCode
The country code for a HostedPage account
returnUrl
The URL a merchant wants a customer to be redirected to after a HostedPage based transaction is completed.
language
Language of the payment pages
processorPaymentMethodId
processorPaymentMethodId
billingAgreementId
If supported by the processor, the token used to rebill this payment method in the future.

 

Mandate       Back to top

Member Name Type Min. Qty
created xsd:dateTime 0
identifier xsd:string 0
status MandateStatus 0

Details of mandate authorizing Direct Debit charges

created
Date and time when this mandate was created.
identifier
Unique reference for this mandate.
status
Describes the current status for this mandate.

 

MerchantAcceptedPayment       Back to top

Member Name Type Min. Qty
amount xsd:decimal 0
currency xsd:string 0
token Token 0
timestamp xsd:dateTime 0
paymentType xsd:string 1
paymentId xsd:string 0
account xsd:string 0
lastDigits xsd:string 0
accountLength xsd:int 0
hashType HashType 0
accountHash xsd:string 0
note xsd:string 0

Details for a payment applied directly by Merchant.

amount
Amount payed by customer. This value must be 0 for PaymentMethods attached to AutoBills Note: MerchantAcceptedPayment PaymentMethods are attached to AutoBills to indicate that the customer should be invoiced (rather than automatically charged).
currency
ISO 4217 currency code for payment. Currency or token must be specified, (and must match the currency for charges contained in the invoice/autobill)
token
Token associated with amount (if this is a Token-based autobill).
timestamp
Time that payment payment occurred
paymentType
The type of payment accepted my merchant. 64 bytes max.
paymentId
The type of payment accepted my merchant. 255 bytes max.
account
The full account number. 255 bytes max.
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.
note
Note regarding payment being made

 

MerchantEntitlementId       Back to top

Member Name Type Min. Qty
id xsd:string 1
description xsd:string 0

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.

 

MigrationTaxItem       Back to top

Member Name Type Min. Qty
amount xsd:decimal 1
jurisdiction xsd:string 0
name xsd:string 0

A tax line-item in a MigrationTransactionItem.

amount
Tax amount in the currency of the overall transaction.
jurisdiction
Sales tax jurisdiction
name
Sales tax name

 

MigrationTransaction       Back to top

Member Name Type Min. Qty
account Account 0
merchantTransactionId xsd:string 0
type MigrationTransactionType 0
amount xsd:decimal 0
currency xsd:string 0
autoBillCycle xsd:int 0
merchantBillingPlanId xsd:string 0
billingPlanCycle xsd:int 0
billingDate xsd:dateTime 0
retryNumber xsd:int 0
migrationTransactionItems MigrationTransactionItem (0 or more) 0
paymentMethod PaymentMethod 1
verificationCode xsd:string 0
taxInclusive xsd:boolean 0
taxExemptions TaxExemption (0 or more) 0
salesTaxAddress Address 0
shippingAddress Address 0
paymentProcessor xsd:string 0
paymentProcessorTransactionId xsd:string 0
divisionNumber xsd:string 0
merchantAffiliateId xsd:string 0
merchantAffiliateSubId xsd:string 0
preferredNotificationLanguage xsd:string 0
sourceIp xsd:string 0
nameValues NameValuePair (0 or more) 0
statusLog TransactionStatus (1 or more) 1

Describes a transaction to be migrated into Vindicia from another billing system

account
The Account (i.e., Customer) account associated with this transaction. If this migrationTransaction is included in an AutoBill migration request, the Account on the AutoBill will be used instead of this field.
merchantTransactionId
The merchant's unique ID for this transaction. 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. If not specified, this field will be filled in by Vindicia
type
Transaction type (i.e. recurring vs non-recurring). For MigrationTransactions included in an AutoBill.Migrate request this will default to Recurring. For MigrationTransactions included in a Transaction.Migrate request, the value NonRecurring shall be used.
amount
Amount of the transaction, as a decimal. Must be non-negative, and add up to the total value of the all the TransactionItems associated.
currency
ISO 4217 Currency Code of this transaction; defaults to USD if not specified.
autoBillCycle
Billing sequence for the Transaction within the life of an AutoBill. This field is required for transactions included in an AutoBill migration request (and unique for all Transactions associated with an AutoBill). The field will be ignored for Transactions not included in an AutoBill migration request.
merchantBillingPlanId
Merchant's unique ID for the (AutoBill) BillingPlan associated with this Transaction. The BillingPlan should exist within CashBox prior to migrating Transactions that reference it. This field is required for Transactions included in an AutoBill migration request (and will be ignored otherwise)
billingPlanCycle
Billing sequence for the Transaction within the specified BillingPlan. This field is required for transactions included in an AutoBill migration request. The field will be ignored for Transactions not included in an AutoBill migration request.
billingDate
the AutoBill BillingPlan period start date/time associated with the Transaction.
retryNumber
0-based index indicating the billing attempt within a given billing period. For example, if this is the first billing attempt for a given billing period, the value will be 0. If the first billing attempt fails, and a second Transaction is attempted for the same billing period, the value will be 1. This field will be ignored for Transactions that are not included in an AutoBill migration request. If the migrationTransaction is included in an AutoBill migration request, but retryNumber is not specified, Vindicia will assume 0.
migrationTransactionItems
MigrationTransactionItem array to list the individual line-items that make up this larger transaction.
paymentMethod
The PaymentMethod (e.g., a credit card) that funds were deducted from for this transaction.
verificationCode
Response from other verification system for this transaction (e.g., Verified by Visa (VbV) or MasterCard SecureCode).
taxInclusive
If set to true, then CashBox treats the tax amount(s) as inclusive of the MigrationTransactionItem price value when calculating the total cost of the Transaction. If it's set to false, then CashBox adds the tax amount(s) in addition to the MigrationTransactionItem price value when calculating the total cost of the Transaction.
taxExemptions
Exemptions that apply to this transaction
salesTaxAddress
Address used in calculation of sales tax on this transaction. This field should be included if Merchant is including taxes in the Transaction.
shippingAddress
Address shipping address associated with this transaction, if any. No shipping address is required, but it may be helpful when attempting to resolve chargebacks.
paymentProcessor
The payment processor used for processing this transaction. This value should match a Payment Processor supported by Vindicia (i.e. FDMS, Litle, MeS, Paymentech etc.). If the Payment Processor is not supported by Vindicia, the migrationTransaction will be imported, but supplemental actions (i.e. refunds) will not be supported. If a value is not provided for this field, then Vindicia will attempt to derive the Payment Processor from the Merchant's routing rules.
paymentProcessorTransactionId
The identifier assigned to the Transaction by the Payment Processor.
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.
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.
preferredNotificationLanguage
Language to be used in the email notification, specified as an ISO language string.
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.
nameValues
Optional array of name/value pairs the merchant wishes to associate with a Transaction
statusLog
A log of various TransactionStatus entries (with accurate timestamps) associated with this transaction. As a minimum, this should have an entry corresponding to the current status of the transaction.

 

MigrationTransactionItem       Back to top

Member Name Type Min. Qty
itemType MigrationTransactionItemType 0
servicePeriodStartDate xsd:dateTime 0
servicePeriodEndDate xsd:dateTime 0
merchantAutoBillItemId xsd:string 0
sku xsd:string 1
name xsd:string 1
price xsd:decimal 1
taxClassification xsd:string 0
migrationTaxItems MigrationTaxItem (0 or more) 0

A line-item in a MigrationTransaction. All line-items added together should add up to the total transaction amount.

itemType
The type of charge for this item (i.e. recurring vs non-recurring). If unspecified the type will default to RecurringCharge.
servicePeriodStartDate
The entitlement start date for this item (generally associated with an AutoBill item). If unspecified, defaults to the MigrationTransaction billingDate.
servicePeriodEndDate
The entitlement end date for this item (generally associated with an AutoBill item).
merchantAutoBillItemId
Optional merchant-supplied unique name for the AutoBillItem associated with this MigrationTransactionItem. This is useful in the event an AutoBill has two or more AutoBillItems with the same Product (SKU), and a need exists to distinguish between the two.
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. For AutoBill-based MigrationTransactions, this will match the (Product) SKU on the associated AutoBillItem
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.
taxClassification
Item tax classification.
migrationTaxItems
Taxes associated with this MigrationTransactionItem

 

NameValuePair       Back to top

Member Name Type Min. Qty
name xsd:string 1
value xsd:string 1

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)

 

PayPal       Back to top

Member Name Type Min. Qty
paypalEmail xsd:string 0
payerId xsd:string 0
returnUrl xsd:string 0
cancelUrl xsd:string 0
requestReferenceId xsd:boolean 0
referenceId xsd:string 0

Details for a PayPal account.

paypalEmail
Email used in PayPal ExpressCheckout 127 single-byte limit. Read-only field
payerId
unique PayPal customer account identification number in PayPal ExpressCheckout 13 single-byte alpha numeric characters limit. Read-only field
returnUrl
The URL a merchant wants a customer to be redirected to after a PayPal based transaction is completed. Per PayPal recommendation this should be the final review page on which the customer confirms the order and payment or billing agreement
cancelUrl
The URL a merchant wants a customer to be redirected if the customer does not approve payment via PayPal. Per PayPal recommendation this this should be the original page on which the customer chose to pay with PayPal or establish a billing agreement.
requestReferenceId
When processing a one-time transaction ask PayPal for a reference id that can be used in the future for recurring billing. This will only work if you have been previously approved for Reference Transactions by PayPal. NOTE: This field is ignored when using AutoBills where the need for a reference id is implied.
referenceId
Billing Agreement ID or Reference Transaction ID associated with a PayPal Billing Agreement.

 

PaymentDetails       Back to top

Member Name Type Min. Qty
merchantProductId xsd:string 0
productVid xsd:string 0
merchantAutoBillItemId xsd:string 0
autoBillItemVid xsd:string 0
remainingBalanceInSet xsd:decimal 0
remainingPaymentsInSet xsd:int 0

information about the payment due to this item

merchantProductId
merchant assigned unique id - aka SKU
productVid
Vindicia ID for the object
merchantAutoBillItemId
merchant assigned unique id
autoBillItemVid
Vindicia ID for the object
remainingBalanceInSet
remaining balance for this item
remainingPaymentsInSet
remaining number of payments for this item

 

PaymentMethod       Back to top

Member Name Type Min. Qty
VID xsd:string 0
type PaymentMethodType 0
creditCard CreditCard 0
ecp ECP 0
directDebit DirectDebit 0
paypal PayPal 0
amazon Amazon 0
skrill Skrill 0
boleto Boleto 0
hostedPage HostedPage 0
token Token 0
merchantAcceptedPayment MerchantAcceptedPayment 0
carrierBilling CarrierBilling 0
applePay ApplePay 0
nameValues NameValuePair (0 or more) 0
accountHolderName xsd:string 0
billingAddress Address 0
customerSpecifiedType xsd:string 0
customerDescription xsd:string 0
merchantPaymentMethodId xsd:string 0
currency xsd:string 0
sortOrder xsd:int 0
active xsd:boolean 0

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.
amazon
The Amazon account details for a PaymentMethod of type Amazon.
skrill
The Skrill account details for a PaymentMethod of type Skrill.
boleto
Details for a Boleto Bancario payment
hostedPage
Details of payment accepted/applied via hosted by payment provider billing pages
token
Details of payment via tokens
merchantAcceptedPayment
Details of payment accepted/applied by a merchant
carrierBilling
Details of payment accepted/applied via carrier billing (i.e. pay-by-mobile)
applePay
Details of payment accepted via ApplePay
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 payment method. If this payment method describes a credit card, use one of the following strings depending on card type: Visa, AmEx, Mastercard, Switch, Solo, Dankort, Laser, JCB, Discover, CarteBleue, Diners. Usage of one of the exact card type strings as mentioned here is especially important for Switch, Solo, Dankort, Laser, CarteBleue cards since Vindicia can not figure these card types by examining account numbers on these cards
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 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.

 

PaymentMethodUpdate       Back to top

Member Name Type Min. Qty
paymentMethod PaymentMethod 0
created xsd:boolean 0
validated xsd:boolean 0
score xsd:int 0
scoreCodes ScoreCode (0 or more) 0
authStatus TransactionStatus 0

Creates a new PaymentMethod object or updates an existing one.

paymentMethod
The resultant object
created
True if the object was created new
validated
True if the payment method was successfully validated
score
The score of the transaction based upon the information provided. Ranges from 0 (best) to 100 (worst). May also be -1, indicating that Vindicia has no opinion, or -2 indicating an error condition. -2 error transactions should be retried later in order to complete the transaction database for chargeback challenging. Further information about why a given score was returned is available in scoreCodes. If the transaction score is not acceptable, the score may be improved by presenting the information in scoreImprovements to the user and resubmitting a score call.
scoreCodes
Array containing strings that explain why the risk score came out be of a certain value
authStatus
If payment method validation was requested, this object will contain more information on response to the validation from the payment processor. You can examine this object for things such as Address Verification (AVS) response code, CVV response code, etc.

 

PaymentMethodValidate       Back to top

Member Name Type Min. Qty
authStatus TransactionStatus 0
validated xsd:boolean 0
score xsd:int 0
scoreCodes ScoreCode (0 or more) 0

Evaluates a PaymentMethod for fraud and validates it by contacting a payment processor and assures its correctness

authStatus
If the payment processor was contacted for validation, this object will contain more information on response to the validation from the payment processor. You can examine this object for things such as Address Verification (AVS) response code, CVV response code, etc.
validated
True if the payment method was successfully validated. This will be available if the fraud score was satisfactory and validation was done by contacting the payment processor
score
The fraud score of for the payment method based on the information provided. Ranges from 0 (best) to 100 (worst). May also be -1, indicating that Vindicia has no opinion, or -2 indicating an error condition. -2 error validation should be retried later. Further information about why a given score was returned is available in scoreCodes.
scoreCodes
Array containing strings that explain why the risk score came out be of a certain value

 

PaymentProvider       Back to top

Member Name Type Min. Qty
name xsd:string 1
disputeAddress Address 0
disputeEmail xsd:string 0
disputeUri xsd:anyURI 0
authExpirationDays xsd:int 0
authCurrencyOverride xsd:string 0
nameValues NameValuePair (0 or more) 0

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

name
Name of the provider
disputeAddress
The Payment Provider dispute address.
disputeEmail
Payment Provider email address for disputes.
disputeUri
Payment Provider URI for disputes.
authExpirationDays
Days before Payment Provider expires auths
authCurrencyOverride
Currencies for which Auth currency may be overriden by USD
nameValues
Optional array of name/value pairs associated with a PaymentProvider

 

PhoneNumber       Back to top

Member Name Type Min. Qty
phoneType PhoneType 0
countryCode xsd:string 0
areaCode xsd:string 1
localNumber xsd:string 1
extension xsd:string 0
rawInput xsd:string 0

Phone Number

phoneType
Type of phone.
countryCode
Country Code segment of a phone number
areaCode
Area Code segment of a phone number
localNumber
Local Number (excluding extension)
extension
Phone number extension
rawInput
Raw, unfiltered data input by customer

 

PriceCriteria       Back to top

Member Name Type Min. Qty
paymentProvider PaymentProvider 0
currency xsd:string 0
countryCode xsd:string 0
pricePointDeviationPolicy PricePointDeviationPolicy 0
dynamicPriceMode DynamicPriceMode 0
merchantServiceIdentifier xsd:string 0
subMerchantIdentifier xsd:string 0
description xsd:string 0
fwdUrl xsd:string 0
staticSelectionRowRef xsd:int 0
staticPriceIncSalesTax xsd:decimal 0
dynamicDeviation xsd:int 0
dynamicMatch xsd:int 0
dynamicTargetPrice xsd:decimal 0

Dynamic Pricing Criteria for Transactions using CarrierBilling PaymentMethods.

paymentProvider
PaymentProvider selected for Transaction. Currently only BOKU is supported. This value will override CarrierBilling.paymentProvider
currency
ISO 4217 Currency Code for for either the static_price_inc_salestax, or the dynamic_target_price (For dynamic pricing, the actual customer currency will be determined by the customer region/countryCode). This value will override CarrierBilling.currency
countryCode
ISO 3166-1 alpha-2 countryCode for customer location. This value will override CarrierBilling.countryCode
pricePointDeviationPolicy
The price deviation policy for dynamic price selection.
dynamicPriceMode
Which price point element is matched by the dynamic pricing algorithm.
merchantServiceIdentifier
Service identifier for Payment Provider/Merchant
subMerchantIdentifier
Optional identifier of sub-merchant associated with Transaction.
description
Description
fwdUrl
Overrides both the successful transaction forward-to URL and the failed transaction forward-to URL.
staticSelectionRowRef
Row number identifier in the static product/service price matrix
staticPriceIncSalesTax
Price including tax (the actual amount the consumer will pay). Used with Transactions with static 'exact match' pricing
dynamicDeviation
The % deviation (+/- 1000) from the target value that is acceptable as a price point selection.
dynamicMatch
The % deviation (+/- 1000) from the target value that is classified as an exact match
dynamicTargetPrice
Target price in the specified currency for dynamic pricing.

 

Product       Back to top

Member Name Type Min. Qty
VID xsd:string 0
merchantProductId xsd:string 0
descriptions ProductDescription (0 or more) 0
status ProductStatus 0
taxClassification xsd:string 0
defaultBillingPlan BillingPlan 0
defaultRatePlan RatePlan 0
endOfLifeTimestamp xsd:dateTime 0
nameValues NameValuePair (0 or more) 0
merchantEntitlementIds MerchantEntitlementId (0 or more) 0
billingStatementIdentifier xsd:string 0
creditGranted Credit 0
prices ProductPrice (0 or more) 0
bundledProducts Product (0 or more) 0

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.
descriptions
Zero or more language/product-description pairs.
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 string.
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.
defaultRatePlan
Optional default ratePlan, for use if this product is rated.
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. Support for this string and its allowable format depends on your payment processor. Please consult your Vindicia contact if you wish to use this.
creditGranted
The credit(s) to be granted upon purchase of this Product
prices
Zero or more price and optional token amounts.
bundledProducts
Zero or more products 'bundled' or associated with this product

 

ProductDescription       Back to top

Member Name Type Min. Qty
language xsd:string 1
description xsd:string 1

A language/product-description pair.

language
The language in which the product description is written.
description
A description of this product written in 'language'. It is a free-form string of less than 256 characters.

 

ProductPrice       Back to top

Member Name Type Min. Qty
amount xsd:decimal 1
currency xsd:string 0
token Token 0

An amount and/or token for this product.

amount
Value of the Currency Amount.
currency
ISO 4217 currency code to be used for this Product Price Amount. Defaults to USD.
token
Details of pricing via tokens.

 

RatePlan       Back to top

Member Name Type Min. Qty
description xsd:string 0
merchantRatePlanId xsd:string 0
VID xsd:string 0
multiplyRatedUnitsBy MultiplyRatedUnitsBy 0
ratedUnit RatedUnit 0
tier RatePlanTier (0 or more) 0
roundingDecimals xsd:int 0
includedUnits xsd:decimal 0
minimumFee RatePlanPrice (0 or more) 0
maximumFee RatePlanPrice (0 or more) 0
ratePlanModel RatePlanModel 0
status RatePlanStatus 0
hasEventRecorded xsd:boolean 0
nameValues NameValuePair (0 or more) 0

A "RatePlan" describes how to price rated units that the merchant reports to us, or how to price licenses

description
An optional description for this RatePlan.
merchantRatePlanId
Merchant's unique ID for this RatePlan.
VID
Vindicia's unique ID for this RatePlan. Vindicia will fill this in when the RatePlan is first created.
multiplyRatedUnitsBy
"multiplyRatedUnitsBy" refers to the scheme whereby this RatePlan uses its tiers to calculate a price.
ratedUnit
The unit that this RatePlan refers to.
tier
Tiers of pricing used in the rating model.
roundingDecimals
Number of digits to round unit return values in, using the same method as Excel's ROUND function: 0 means round to the nearest integer, 2 means round to 2 decimal places, -2 means round to the nearest hundred etc.
includedUnits
RUM units included as part of the plan.
minimumFee
Prices of the minimum charge for this plan, per billing cycle
maximumFee
Prices of the MAXIMUM charge for this plan, per billing cycle
ratePlanModel
Mode of use for the RatePlan; this must be either "LicenseBased" or "UsageBased". This field is required.
status
 
hasEventRecorded
Read-only field that tells whether this RatePlan has had any events recorded on it or not
nameValues
An optional array of name-value pair items specific to this RatePlan.

 

RatePlanPrice       Back to top

Member Name Type Min. Qty
amount xsd:decimal 0
currency xsd:string 0

A (currency, amount) pair to be used in a RatePlan

amount
Value of the currency amount.
currency
ISO 4217 currency code to be used for this Rate Plan Amount.

 

RatePlanTier       Back to top

Member Name Type Min. Qty
name xsd:string 0
ratePrice RatePlanPrice (0 or more) 0
chargeCustomer ChargeCustomer 0
beginsAtLevel xsd:decimal 0

A single tier of a RatePlan.

name
 
ratePrice
Price or prices for this tier (one price for each currency used)
chargeCustomer
 
beginsAtLevel
The minimum value for this tier. This tier's range runs from the minimum value to the minimum value of the next higher tier. The actual range of values is the open interval [ beginsAtLevel, nextTierBeginsAtLevel ). Typically the first tier would have beginsAtLevel = 0. The final, highest tier is unbounded.

 

RatedUnit       Back to top

Member Name Type Min. Qty
nameSingular xsd:string 0
namePlural xsd:string 0

RatedUnitSummary       Back to top

Member Name Type Min. Qty
merchantAccountId xsd:string 0
accountVid xsd:string 0
merchantAutoBillId xsd:string 0
autobillVid xsd:string 0
merchantAutoBillItemId xsd:string 0
autobillItemVid xsd:string 0
merchantProductId xsd:string 0
productVid xsd:string 0
merchantRatePlanId xsd:string 0
ratePlanVid xsd:string 0
currentTotalRatedUnitsBill xsd:decimal 0
ratedUnitTotal xsd:decimal 0
ratedUnit RatedUnit 0
eventCount xsd:int 0
currentTier xsd:string 0

Unit charges for a single rated AutoBillItem, and related information about what item those charges refer to.

merchantAccountId
 
accountVid
 
merchantAutoBillId
 
autobillVid
 
merchantAutoBillItemId
 
autobillItemVid
 
merchantProductId
 
productVid
 
merchantRatePlanId
 
ratePlanVid
 
currentTotalRatedUnitsBill
Total amount, in the currency specified on the AutoBill
ratedUnitTotal
 
ratedUnit
The unit used, returned as a convenience
eventCount
 
currentTier
 

 

Refund       Back to top

Member Name Type Min. Qty
VID xsd:string 0
merchantRefundId xsd:string 0
transaction Transaction 0
refundItems RefundItem (0 or more) 0
refundDistributionStrategy xsd:string 0
amount xsd:decimal 0
amountIncludesTax xsd:boolean 0
currency xsd:string 0
nameValues NameValuePair (0 or more) 0
timestamp xsd:dateTime 0
referenceString xsd:string 0
note xsd:string 0
tokenAction RefundTokenAction 0
credit Credit 0
status RefundStatus 0

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.
refundItems
Array of RefundItem objects. May be left empty if the refundDistributionStrategy is not set to SpecifiedItems.
refundDistributionStrategy
Defines strategy for distributing refund amount across the original TransactionItems. Currently supported values include None, SpecifiedItems, and RemainingBalance. If unspecifiend a default value of None will be used.
amount
Amount of the refund. Must be positive, non-zero, and less than or equal to the entire amount of the original transaction (minus the sum of all prior refunds for the Transaction) if the refundItems array is empty. This field will be ignored if refundItems are input. This field may be an arbitrary amount if reporting a historic merchant-processed refund.
amountIncludesTax
Boolean indicating whether the amount is tax-inclusive, or tax-exclusive
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.
nameValues
An optional array of name-value pair items specific to this refund.
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 to 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'.
credit
Credit(s) reversed as part of the refund. This is a read-only field
status
Describes the current status for this refund.

 

RefundItem       Back to top

Member Name Type Min. Qty
transactionItemIndexNumber xsd:decimal 0
sku xsd:string 0
description xsd:string 0
amount xsd:decimal 0
taxOnly xsd:boolean 0
taxes TaxItem (0 or more) 0

A line-item in a Refund that corresponds to a tns:TransactionItem.

transactionItemIndexNumber
Sequence number assigned upon creation to a TransactionItem by CashBox. Either the transactionItemIndexNumber, or the sku must be specified for each RefundItem.
sku
SKU on the original transaction line item (sku need not be passed in if the transactionItemIndexNumber is passed in). If the sku is passed in, and can be used to uniquely identify the transaction item, it will be used, else an error will be returned.
description
Output only. A description of the TransactionItem which will be filled in by CashBox from line item description on the original tns:Transaction
amount
Amount of the requested refund for this item, in the currency of the overall transaction. This amount must not exceed the original TransactionItem amount minus discount(s), minus the sum of all prior refunds against this item. Currencies may not be mixed on a single transaction. This field may be left blank if the taxOnly field is set to TRUE.
taxOnly
If this is true, the "amount" parameter is ignored and the refund amount will be the total of as-yet-un-refunded taxes for this item.
taxes
Read-only array to list the taxes from the original TransactionItem that are being refunded.

 

Return       Back to top

Member Name Type Min. Qty
returnCode ReturnCode 1
returnString xsd:string 0
soapId xsd:string 0

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

returnCode
 
returnString
 
soapId
 

 

SalesTax       Back to top

Member Name Type Min. Qty
description xsd:string 1
tax xsd:decimal 1

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

 

ScoreCode       Back to top

Member Name Type Min. Qty
description xsd:string 0
id xsd:string 0

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

 

Season       Back to top

Member Name Type Min. Qty
description xsd:string 0
startDate xsd:date 0
endDate xsd:date 0

A date range with a description. Used in the SeasonSet object.

description
Description of this item. A free-form string 2048 characters or smaller.
startDate
The date the season starts.
endDate
The date the season ends.

 

SeasonSet       Back to top

Member Name Type Min. Qty
VID xsd:string 0
merchantSeasonSetId xsd:string 0
seasons Season (0 or more) 0
nameValues NameValuePair (0 or more) 0

An array of seasons with an identifier.

VID
Vindicia's Globally Unique Identifier (GUID) for this object. If you do not have a VID, a VID will be provided for you.
merchantSeasonSetId
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.
seasons
Array of seasons that make up the SeasonSet.
nameValues
Optional array of name/value pairs the merchant wishes to associate with a SeasonSet

 

Skrill       Back to top

Member Name Type Min. Qty
billingAgreementId xsd:string 0
payFromEmail xsd:string 0
paymentType xsd:string 0
returnUrl xsd:string 0
cancelUrl xsd:string 0

Details for a Skrill account.

billingAgreementId
The Skrill 1-Tap billing agreement identifier (rec_payment_id).
payFromEmail
The pay_from_email associated with the Skrill account.
paymentType
The Skrill payment_type code.
returnUrl
The URL a merchant wants a customer to be redirected to after a Skrill based transaction is completed.
cancelUrl
The URL a merchant wants a customer to be redirected if the customer does not approve payment via Skrill.

 

TaxExemption       Back to top

Member Name Type Min. Qty
region xsd:string 0
exemptionId xsd:string 0
active xsd:boolean 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.

 

TaxItem       Back to top

Member Name Type Min. Qty
jurisdiction xsd:string 0
name xsd:string 0
amount xsd:decimal 1

Contains specific tax information about a particular transactionItem.

jurisdiction
The sku for the tax jurisdiction
name
The description for the tax jurisdiction
amount
The amount of tax

 

TimeInterval       Back to top

Member Name Type Min. Qty
years xsd:int 0
months xsd:int 0
weeks xsd:int 0
days xsd:int 0
nameValues NameValuePair (0 or more) 0
sortValue xsd:integer 0
description xsd:string 0
reason xsd:string 0
grantedByCashbox xsd:boolean 0
granted xsd:dateTime 0
VID xsd:string 0
accountVID xsd:string 0
merchantAccountId xsd:string 0
autoBillVID xsd:string 0
merchantAutoBillId xsd:string 0
source xsd:string 0

Time Interval

years
Number of years in this time interval. Must be a positive integer.
months
Number of months in this time interval. Must be a positive integer.
weeks
Number of weeks in this time interval. Must be a positive integer.
days
Number of days in this time interval. Must be a positive integer.
nameValues
An optional array of name-value pairs to associate with this time-interval credit.
sortValue
An arbitrary integer that affects where this credit appears in reports.
description
A description of the time-interval credit.
reason
The reason for the time-interval credit.
grantedByCashbox
Indicates if the interval credit was granted by CashBox.
granted
A timestamp that shows when the credit was granted.
VID
Vindicia's Globally Unique Identifier (GUID) for this object. Needed when revoking a credit.
accountVID
Vindicia's Globally Unique Identifier (GUID) for the account associated with this object.
merchantAccountId
The merchant's unique identifier for the account associated with this object.
autoBillVID
Vindicia's Globally Unique Identifier (GUID) for this object's AutoBill.
merchantAutoBillId
The merchant's unique identifier for the AutoBill associated with this object.
source
Describes the source of credit

 

Token       Back to top

Member Name Type Min. Qty
VID xsd:string 0
merchantTokenId xsd:string 0
description xsd:string 0

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

 

TokenAmount       Back to top

Member Name Type Min. Qty
token Token 1
amount xsd:int 1
source xsd:string 0

A quantity of tokens in a particular type

token
The type of token this quantity describes
amount
The quantity of tokens.
source
Describes the source of credit

 

TokenTransaction       Back to top

Member Name Type Min. Qty
tokenAmount TokenAmount 1
description xsd:string 0
authTimestamp xsd:dateTime 1
clearedTimestamp xsd:dateTime 0

A particular transaction using tokens

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

 

Transaction       Back to top

Member Name Type Min. Qty
VID xsd:string 0
amount xsd:decimal 0
originalAmount xsd:decimal 0
currency xsd:string 0
divisionNumber xsd:string 0
merchantTransactionId xsd:string 0
previousMerchantTransactionId xsd:string 0
timestamp xsd:dateTime 0
account Account 0
sourcePaymentMethod PaymentMethod 0
destPaymentMethod PaymentMethod 0
ecpTransactionType ECPTransactionType 0
statusLog TransactionStatus (0 or more) 0
paymentProcessor xsd:string 0
paymentProcessorTransactionId xsd:string 0
sourcePhoneNumber xsd:string 0
shippingAddress Address 0
nameValues NameValuePair (0 or more) 0
transactionItems TransactionItem (0 or more) 0
merchantAffiliateId xsd:string 0
merchantAffiliateSubId xsd:string 0
userAgent xsd:string 0
note xsd:string 0
preferredNotificationLanguage xsd:string 0
sourceMacAddress xsd:string 0
sourceIp xsd:string 0
billingStatementIdentifier xsd:string 0
taxExemptions TaxExemption (0 or more) 0
salesTaxAddress Address 0
verificationCode xsd:string 0
autoBillCycle xsd:int 0
billingPlanCycle xsd:int 0
mandate Mandate 0
originalActivityDate xsd:dateTime 0
retryNumber xsd:int 0
autobillVID xsd:string 0
merchantAutobillIdentifier xsd:string 0

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 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 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.
originalAmount
In the event of a partial payment this read-only field reflects the original amountof the transaction, as a decimal.
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 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 occurred. 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.
paymentProcessorTransactionId
The identifier assigned to the Transaction by the Payment Processor. This value will be filled in by 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
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.
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.
autoBillCycle
The AutoBill billing cycle during which this transaction occurred
billingPlanCycle
The zero-based number of times the AutoBill has been billed for the current billing plan. One-time transactions will have the same value as the previous regularly scheduled billing.
mandate
The mandate authorizing this transaction
originalActivityDate
This is the date of the original_activity for the governing transaction_billing that spawned the transaction (so this is null for one-time transactions or any transaction not part of an autobill).
retryNumber
This is the index which counts the attempt of a particular transaction_billing represented by this transaction. For one-time transactions this is null.
autobillVID
The VID of the AutoBill which 'owns' the transaction. For one-time transactions this is null.
merchantAutobillIdentifier
The product_serial (aka merchant autobill identifier) of the AutoBill which 'owns' the transaction. For one-time transactions this is null.

 

TransactionAuth       Back to top

Member Name Type Min. Qty
transaction Transaction 0
score xsd:int 0
scoreCodes ScoreCode (0 or more) 0

Perform an auth operation on a transaction. The transaction object should be filled out with all available information, then this method is called to actually perform the action. This method has the following output return values:

'400:Must specify transaction to authorize' if no transaction specified
'400:No Account or PaymentMethod information' if neither account nor payment method is specified
'400:Amount negative' if the amount on the transaction is less than zero
'400:Vindicia fault VIN_XXX encountered.' if an internal error with the Vindicia payment system was encountered
'403:Denied' if the chargback probability is greater than minChargebackProbability
'404:Unable to load Account' if the specified account may not be loaded by VID or merchantAccountId
'405:Account has no default payment method' if the specified account is loaded, but no default payment method is available and none is explicitly provided with the transaction

It will return 200 in all other cases, with the result of the transaction processing in the transactionStatus field. The returned transaction will have all respective fields filled out. There is, in general, little validation of the specific values, as all that is completely necessary is an amount and PaymentMethod information, either given explicitly or gotten implicitly from the account. The majority of the remaining information is either useful for fraud prevention or for later disputation of fraudulent chargebacks.

transaction
The transaction object
score
The score of the transaction based upon the information provided. Ranges from 0 (best) to 100 (worst). May also be -1, indicating that Vindicia has no opinion, or -2 indicating an error condition. -2 error transactions should be retried later in order to complete the transaction database for chargeback challenging. Further information about why a given score was returned is available in scoreCodes. If the transaction score is not acceptable, the score may be improved by presenting the information in scoreImprovements to the user and resubmitting a score call.
scoreCodes
Array containing strings that explain why the risk score came out be of a certain value

 

TransactionAuthCapture       Back to top

Member Name Type Min. Qty
transaction Transaction 0

Perform an auth/capture operation on a transaction

transaction
The transaction object

 

TransactionCampaignDiscount       Back to top

Member Name Type Min. Qty
discount xsd:decimal 0
campaignId xsd:string 0

TransactionItem       Back to top

Member Name Type Min. Qty
sku xsd:string 0
indexNumber xsd:int 0
itemType TransactionItemType 0
name xsd:string 1
merchantAutoBillItemId xsd:string 0
autoBillItemVid xsd:string 0
price xsd:decimal 1
nameValues NameValuePair (0 or more) 0
quantity xsd:decimal 1
taxClassification xsd:string 0
tokens TokenAmount (0 or more) 0
campaignCode xsd:string 0
campaignId xsd:string 0
campaignDescription xsd:string 0
servicePeriodStartDate xsd:dateTime 0
servicePeriodEndDate xsd:dateTime 0
taxType xsd:string 0
tax TaxItem (0 or more) 0
relatedTransactions xsd:string (0 or more) 0
itemRefunds TransactionItemRefundSummary (0 or more) 0
discount xsd:decimal 0
subtotal xsd:decimal 0
total xsd:decimal 0

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.
indexNumber
Unique index number for this item. These index numbers start at 1, not 0.
itemType
The type of item. If unspecified the type will default to Purchase.
name
A description of the item. This is a free-form string of 256 or fewer characters.
merchantAutoBillItemId
Optional merchant-supplied unique name for the AutoBillItem associated with this MigrationTransactionItem. This is useful in the event an AutoBill has two or more AutoBillItems with the same Product (SKU), and a need exists to distinguish between the two.
autoBillItemVid
The VID (assigned by Vindicia) for the AutoBillItem associated with the MigrationTransactionItem. If available, inclusion of the AutoBillItem's VID will resolve ambiguities in mapping TransactionItems to AutoBillItems.
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.
nameValues
Optional array of name/value pairs the merchant wishes to associate with an transaction item
quantity
The number of items sold. If that is nonsensical (e.g., for sales tax) simply use '1'
taxClassification
Product type for tax purposes.
tokens
Tokens granted to the account on this transaction for purchasing this item
campaignCode
Campaign code redeemed on this TransactionItem. To apply a campaign, use this field to send in a valid coupon or promotion code.
campaignId
The unique identifier for a campaign applied to this item. This is a read-only field returned by CashBox for informational purposes. Values sent in with a SOAP call are ignored.
campaignDescription
Detailed description of the campaign for the discount on this item, if there is one.
servicePeriodStartDate
The start date for the period the charge on this item covers.
servicePeriodEndDate
The end date for the period the charge on this item covers.
taxType
This is can have the possible values of Inclusive Sales, Exclusive Sales, Inclusive Use, and Exclusive Use
tax
Tax array to list the individual tax items associated with the corresponding transactionItem.
relatedTransactions
List of merchantTransactionIds for all Transactions related to this item. For example, for a credit resulting from the removal of an AutoBillItem, this will contain the list of all Transactions that originally billed for the item within the time frame covered by the credit.
itemRefunds
An array of TransactionItemRefundSummary objects.
discount
Amount of campaign discount on this item, if any.
subtotal
Subtotal of this item, excluding any discounts and tax (if tax-exclusive).
total
Total for this item, including discounts and taxes.

 

TransactionItemRefundSummary       Back to top

Member Name Type Min. Qty
amount xsd:decimal 1
taxAmount xsd:decimal 1
taxOnly xsd:boolean 0
timestamp xsd:dateTime 1
refundId xsd:string 0

Contains summary of Refunds against a TransactionItem.

amount
Full or partial amount of the refund.
taxAmount
Full or partial amount of tax refunded.
taxOnly
If set to true, then CashBox refunded only the tax portion of a TransactionItem.
timestamp
Timestamp when the refund was issued.
refundId
merchantRefundId of the Refund object where the refund was issued.

 

TransactionStatus       Back to top

Member Name Type Min. Qty
status TransactionStatusType 1
timestamp xsd:dateTime 1
paymentMethodType PaymentMethodType 1
creditCardStatus TransactionStatusCreditCard 0
ecpStatus TransactionStatusECP 0
boletoStatus TransactionStatusBoleto 0
hostedPageStatus TransactionStatusHostedPage 0
payPalStatus TransactionStatusPayPal 0
directDebitStatus TransactionStatusDirectDebit 0
carrierBillingStatus TransactionStatusCarrierBilling 0
amazonStatus TransactionStatusAmazon 0
skrillStatus TransactionStatusSkrill 0
applePayStatus TransactionStatusApplePay 0
vinAVS AVSMatchType 0
fundingSourceBalance xsd:decimal 0

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
hostedPageStatus
Status details for a HostedPage 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
carrierBillingStatus
Status details for a CarrierBilling Transaction
amazonStatus
Status details for a Amazon Transaction
skrillStatus
Status details for a Skrill Transaction
applePayStatus
Status details for an ApplePay Transaction
vinAVS
Indicates status of AVS (address verification) as a simple string. Requires AVS be enabled with the payment processor
fundingSourceBalance
The outstanding available balance on the submitted PaymentMethod.

 

TransactionStatusAmazon       Back to top

Member Name Type Min. Qty
authCode xsd:string 0

Amazon transaction status related information.

authCode
Result code for the status update.

 

TransactionStatusApplePay       Back to top

Member Name Type Min. Qty
authCode xsd:string 1

Status details for an ApplePay 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.

 

TransactionStatusBoleto       Back to top

Member Name Type Min. Qty
uri xsd:string 0

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

 

TransactionStatusCarrierBilling       Back to top

Member Name Type Min. Qty
authCode xsd:string 1
buyUrl xsd:string 0

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

authCode
Result code for the requested action
buyUrl
URL which (when sourced on a customer web browser) generates HTML elements to facilitate processing of a CarrierBilling payment

 

TransactionStatusCreditCard       Back to top

Member Name Type Min. Qty
authCode xsd:string 1
avsCode xsd:string 0
cvnCode xsd:string 0
extendedCardAttributes ExtendedCardAttributes 0

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.
extendedCardAttributes
Additional credit card details returned from Payment Provider

 

TransactionStatusDirectDebit       Back to top

Member Name Type Min. Qty
authCode xsd:string 0

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

 

TransactionStatusECP       Back to top

Member Name Type Min. Qty
authCode xsd:string 0

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.

 

TransactionStatusHostedPage       Back to top

Member Name Type Min. Qty
authCode xsd:string 1
redirectUrl xsd:string 0

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

authCode
Result code for the status update.
redirectUrl
The Hosted Pages URL merchant should redirect a customer to complete a HostedPage transaction

 

TransactionStatusPayPal       Back to top

Member Name Type Min. Qty
token xsd:string 0
paypalEmail xsd:string 0
payerId xsd:string 0
authCode xsd:string 0
redirectUrl xsd:string 0

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

token
Token for PayPal ExpressCheckout
paypalEmail
Email used in PayPal ExpressCheckout 127 single-byte limit
payerId
Unique PayPal customer account identification number in PayPal ExpressCheckout 13 single-byte alpha numeric characters limit
authCode
Result code for the status update. This is a place holder for future implementation
redirectUrl
The PayPal URL merchant should redirect a customer to complete a PayPal transaction

 

TransactionStatusSkrill       Back to top

Member Name Type Min. Qty
authCode xsd:string 0
token xsd:string 0
redirectUrl xsd:string 0

Skrill transaction status related information.

authCode
Result code for the status update.
token
Session id for Skrill Gateway
redirectUrl
The Skrill URL merchant should redirect a customer to complete a Skrill transaction

 

TransactionValidationResponse       Back to top

Member Name Type Min. Qty
merchantTransactionId xsd:string 1
code xsd:int 1
description xsd:string 1

Describes a specific validation issue with a submitted transaction.

merchantTransactionId
The merchant's unique ID for the submitted transaction.
code
A numerical code indicating the type of issue that was encountered. Specific codes can be found in the Vindicia Select Implementation Guide.
description
A human readable description of the issue encountered.

 

WebSession       Back to top

Member Name Type Min. Qty
VID xsd:string 0
method xsd:string 0
version xsd:string 0
returnURL xsd:string 0
errorURL xsd:string 0
ipAddress xsd:string 0
expireTime xsd:dateTime 0
nameValues NameValuePair (0 or more) 0
postValues NameValuePair (0 or more) 0
methodParamValues NameValuePair (0 or more) 0
privateFormValues NameValuePair (0 or more) 0
apiReturn Return 0
apiReturnValues WebSessionMethodReturn 0

A web session

VID
Vindicia's Globally Unique Identifier (GUID) for this object
method
The method that this session is associated with. If any other method is called the result will be an error
version
The version of the API that was used when making the call
returnURL
The URL to redirect requests to after processing succeeds
errorURL
The URL to redirect requests to after processing fails
ipAddress
The IP address of the browser making the request
expireTime
Indicates when the session will expire
nameValues
Optional array of name/value pairs. Any values provided here will be mirrored on the objects created by the WebSession
postValues
Optional array of name/value pairs. Any non-Vindicia form values received in the POST will be added here.
methodParamValues
Optional array of name/value pairs that describe the values that should be used for the method's parameters
privateFormValues
Optional array of name/value pairs that define form variables that you do not want exposed to the client. An example of this would be the VID or merchantId of a BillingPlan. In the event you want to determine these values from user input (e.g. from a select or radio form element) this MUST be used to constrain the input that is exceptable in order to avoid client-side attacks. As an example, if you were calling the AutoBill_Update method and wanted to allow a user to choose a BillingPlan from three options you might define a name-value pair where the name was 'BillingPlan_VID' and the value was a list of valid BillingPlan VIDs in the form 'vid1, vid2, vid3'. If the value received from the form POST is not in the list an error will be returned.
apiReturn
The return value from the WebSession form POST or the underlying SOAP API call
apiReturnValues
Method Object Returned by WebSession Request

 

WebSessionMethodReturn       Back to top

Member Name Type Min. Qty
method xsd:string 0
paymentMethodValidate PaymentMethodValidate 0
paymentMethodUpdate PaymentMethodUpdate 0
transactionAuth TransactionAuth 0
autoBillUpdate AutoBillUpdate 0
transactionAuthCapture TransactionAuthCapture 0
accountUpdatePaymentMethod AccountUpdatePaymentMethod 0
accountUpdate AccountUpdate 0

Method Object Returned by WebSession Request

method
Soap API Method used
paymentMethodValidate
PaymentMethod validate Return Object
paymentMethodUpdate
PaymentMethod update Return Object
transactionAuth
Transaction auth Return Object
autoBillUpdate
AutoBill update Return Object
transactionAuthCapture
Transaction authCapture Return Object
accountUpdatePaymentMethod
Account updatePaymentMethod Return Object
accountUpdate
Account update Return Object

 

Enumerations

EmailPreference       Back to top

Base Type xsd:string
Value Description
plaintext  
html  
multipart  

The preference of an account to receive text or HTML emails

PaymentUpdateBehavior       Back to top

Base Type xsd:string
Value Description
Update  
Validate  
CatchUp  

Action to take on payment method update

AccountPayerReplacementBehavior       Back to top

Base Type xsd:string
Value Description
ReplaceOnAllAutoBills  
ReplaceOnlyFutureAutoBills  

Action to take on methods that may, as a side effect, change who pays for an AutoBill (Account::addChildren, for example)

ActivityCancelInitType       Back to top

Base Type xsd:string
Value Description
Merchant  
Customer  
Chargeback  

Enumeration of the known types of initiators for cancellation activities

ActivityType       Back to top

Base Type xsd:string
Value Description
Login  
Logout  
URIView  
Phone  
Email  
Fulfillment  
Usage  
NamedValue  
Cancellation  
Note  

Enumeration of the known types of activities

ActivityCallType       Back to top

Base Type xsd:string
Value Description
FromMerchantToCustomer  
FromMerchantToOther  
FromCustomerToMerchant  
FromCustomerToOther  
FromOtherToCustomer  
FromOtherToMerchant  

Enumeration of the types of call an Activity describes

AddressType       Back to top

Base Type xsd:string
Value Description
Shipping  
Billing  

AutoBillStatus       Back to top

Base Type xsd:string
Value Description
Unknown  
Deleted  
Processing  
Pending Activation  
Active  
Pending Cancel  
Cancelled  
Expired  
Upgraded  
Legacy Suspended  
Bogus AutoBill Status  
Dryrun  

Status of this particular autobill

BillingState       Back to top

Base Type xsd:string
Value Description
Unknown  
Unbilled  
Good Standing  
Free/Trial  
In Retry  
Unusable PaymentMethod  
Billing Completed  
Failed To Collect  
Overdue  
Pending Acceptance  
Free Period  
Terminated  
Legacy Unknown BillingState  
Bogus BillingState  
Grace Period  

ImmediateAuthFailurePolicy       Back to top

Base Type xsd:string
Value Description
doNotSaveAutoBill  
putAutoBillInRetryCycle  
putAutoBillInRetryCycleIfPaymentMethodIsValid  

How to respond to Auth failure when creating initial Transaction for an AutoBill

StatementFormat       Back to top

Base Type xsd:string
Value Description
DoNotSend  
Inline  
Attachment  

How to format billing statements sent to customer

PaymentOverageDisposition       Back to top

Base Type xsd:string
Value Description
applyToThisAutoBill  
applytoOldestInvoice  
applytoCredit  

How to disposition amounts in excess of a required AutoBill payment amount.

InvoiceStates       Back to top

Base Type xsd:string
Value Description
Open  
Due  
Paid  
Overdue  
Written Off  

States of an invoice.

AutoBillModificationAction       Back to top

Base Type xsd:string
Value Description
Edit  
Add  
Remove  

The type of action used when editing an AutoBillItem.

BillingPlanStatus       Back to top

Base Type xsd:string
Value Description
Active  
Suspended  

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

BillingPeriodType       Back to top

Base Type xsd:string
Value Description
Day  
Week  
Month  
Year  

Unit of time a period describes

CampaignState       Back to top

Base Type xsd:string
Value Description
Undefined  
Active  
Inactive  
Pending  
Complete  
MatchAnyState  

CampaignType       Back to top

Base Type xsd:string
Value Description
Undefined  
Coupon  
Promotion  

PromotionType       Back to top

Base Type xsd:string
Value Description
Undefined  
Rolling  
Fixed  

PromotionPeriodLengthType       Back to top

Base Type xsd:string
Value Description
Undefined  
Day  
Week  
Month  
Year  
Hour  
BillingCycle  

CouponCodeState       Back to top

Base Type xsd:string
Value Description
Not Yet Activated  
Activated  
Redeemed  
Expired  
Marked Used  
Retrieved  
Invalidated  
Initialized  

State of a CouponCode, expressing whether it has been redeemed, expired etc.

CampaignTimeGrantLengthType       Back to top

Base Type xsd:string
Value Description
Day  
Week  
Month  
Year  

ChargebackStatus       Back to top

Base Type xsd:string
Value Description
New  
Retrieval  
Responded  
Legitimate  
Challenged  
Represented  
Won  
Lost  
CollectionsNew  
CollectionsWon  
CollectionsLost  
Expired  
Pass  
Incomplete  
NewSecondChargeback  
Duplicate  

TimeIntervalType       Back to top

Base Type xsd:string
Value Description
Day  
Week  
Month  
Year  

Unit of time

CreditEventType       Back to top

Base Type xsd:string
Value Description
GiftCardRedemption  
GiftCardReversal  
GiftCardStatusInquiry  
Grant  
Revocation  
Consumption  
Refund  

Type describing a specific credit related event

GiftCardActivityType       Back to top

Base Type xsd:string
Value Description
Redeem  
Reverse  

GiftCardStatusType       Back to top

Base Type xsd:string
Value Description
Unknown  
Active  
RedemptionPending  
Redeemed  
Deactive  
Suspended  

EmailTemplateType       Back to top

Base Type xsd:string
Value Description
PreBilling  
PreBillingNoPaymentMethod  
Success  
FailureSoftFail  
FailureHardFail  
FailureNoPaymentMethod  
BillingDelay  
BillingDelayNoPaymentMethod  
Cancellation  

Defines the situation in which an EmailTemplate should be used

PaymentMethodType       Back to top

Base Type xsd:string
Value Description
CreditCard  
PayPal  
ECP  
DirectDebit  
Token  
HostedPage  
Boleto  
MerchantAcceptedPayment  
CarrierBilling  
Amazon  
Skrill  
ApplePay  

The type of a given payment method

HashType       Back to top

Base Type xsd:string
Value Description
sha1  
md5  

Type of hash algorithm

AccountType       Back to top

Base Type xsd:string
Value Description
ConsumerChecking  
ConsumerSavings  
CorporateChecking  
CorporateSavings  

Type of bank account, for ECP accounts

ECPTransactionType       Back to top

Base Type xsd:string
Value Description
All  
Inbound  
Outbound  
InboundOutbound  
Transfer  
NA  

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

PricePointDeviationPolicy       Back to top

Base Type xsd:string
Value Description
HiPreferred  
HiOnly  
LowPreferred  
LowOnly  
NearestNoPreference  

Allowed deviation policy for CarrierBilling payments using dynamic pricing

DynamicPriceMode       Back to top

Base Type xsd:string
Value Description
Price  
PayoutGross  
PayoutNet  

Specifies which price point element is matched by the dynamic pricing algorithm

ProductStatus       Back to top

Base Type xsd:string
Value Description
Active  
Suspended  

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

DuplicateBehavior       Back to top

Base Type xsd:string
Value Description
Duplicate  
SucceedIgnore  
Fail  

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

MultiplyRatedUnitsBy       Back to top

Base Type xsd:string
Value Description
EachRespectiveTier  
HighestApplicableTier  

RatePlanModel       Back to top

Base Type xsd:string
Value Description
UsageBased  
LicenseBased  

ChargeCustomer       Back to top

Base Type xsd:string
Value Description
FlatFee  
PerUnit  

RatePlanStatus       Back to top

Base Type xsd:string
Value Description
Active  
Suspended  

BilledStatus       Back to top

Base Type xsd:string
Value Description
Billed  
Unbilled  

EventRecordMethod       Back to top

Base Type xsd:string
Value Description
Add  
Deduct  
SetTotal  

RefundTokenAction       Back to top

Base Type xsd:string
Value Description
None  
CancelZeroBalance  
CancelNegativeBalance  

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

RefundStatus       Back to top

Base Type xsd:string
Value Description
Reported  
Processing  
Failed  
Complete  

Describes the current status for a refund.

ReturnCode       Back to top

Base Type xsd:int
Value Description
200  
201  
202  
203  
204  
205  
206  
261  
300  
301  
302  
303  
304  
305  
306  
307  
400  
401  
402  
403  
404  
405  
406  
407  
408  
409  
410  
411  
412  
413  
414  
415  
416  
417  
500  
501  
502  
503  
504  
505  

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.

 

TransactionItemType       Back to top

Base Type xsd:string
Value Description
Purchase  
Credit  
TaxableCredit  
DiscountBeforeTax  
ModificationRefund  

TransactionStatusType       Back to top

Base Type xsd:string
Value Description
New  
AuthorizationPending  
AuthorizedPending  
Authorized  
AuthorizedForValidation  
Cancelled  
Captured  
Settled  
Refunded  
Pending  

AVSMatchType       Back to top

Base Type xsd:string
Value Description
FullMatch  
PartialMatch  
NoMatch  
IssuerError  
NoOpinion  
NotSupported  

TransactionAttemptSummary       Back to top

Base Type xsd:string
Value Description
Success  
Failure  
Pending  

Summary of effort to process Transaction.

MigrationTransactionType       Back to top

Base Type xsd:string
Value Description
Recurring  
NonRecurring  

MigrationTransactionItemType       Back to top

Base Type xsd:string
Value Description
RecurringCharge  
NonRecurringCharge  
Credit  

PhoneType       Back to top

Base Type xsd:string
Value Description
Unspecified  
Home  
Work  
Mobile  
Fax  
Pager  
Main  
CS  

Type of phone

MandateStatus       Back to top

Base Type xsd:string
Value Description
Pending  
Active  
Failed  
Cancelled  
Expired  

Describes the current status for a mandate.