Transaction

Methods

fetchByVid http://soap.vindicia.com/Transaction#fetchByVid

Input (fetchByVid_in)

Name	Type
auth	Authentication
vid	xsd:string

Output (fetchByVid_out)

Name	Type
return	Return
transaction	Transaction

Loads a transaction for a Vindicia ID

Input Fields

auth: Credentials required to authenticate this request
vid: Vindicia ID for the object

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transaction: The transaction object with this VID

fetchByAccount http://soap.vindicia.com/Transaction#fetchByAccount

Input (fetchByAccount_in)

Name	Type
auth	Authentication
account	Account

Output (fetchByAccount_out)

Name	Type
return	Return
transactions	ArrayOfTransactions

Loads transactions for an account

Input Fields

auth: Credentials required to authenticate this request
account: Account to load by

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transactions: Array of transaction objects associated with account

fetchByMerchantTransactionId http://soap.vindicia.com/Transaction#fetchByMerchantTransactionId

Input (fetchByMerchantTransactionId_in)

Name	Type
auth	Authentication
merchantTransactionId	xsd:string

Output (fetchByMerchantTransactionId_out)

Name	Type
return	Return
transaction	Transaction

Loads a transaction for a merchant transaction ID

Input Fields

auth: Credentials required to authenticate this request
merchantTransactionId: Merchant's unique ID for transaction

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transaction: The transaction object with this merchant transaction id

fetchDeltaSince http://soap.vindicia.com/Transaction#fetchDeltaSince

Input (fetchDeltaSince_in)

Name	Type
auth	Authentication
timestamp	xsd:dateTime
page	xsd:int
pageSize	xsd:int
paymentMethod	PaymentMethod

Output (fetchDeltaSince_out)

Name	Type
return	Return
transactions	ArrayOfTransactions

Loads a list of transactions that have changed since a timestamp.

Input Fields

auth: Credentials required to authenticate this request
timestamp: All transactions after this timestamp
page: Optional page number to begin results returned
pageSize: Optional number of results to display per a page
paymentMethod: Optional payment method to constrain changes against

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transactions: Array of transaction objects that have changed since the timestamp

fetchDelta http://soap.vindicia.com/Transaction#fetchDelta

Input (fetchDelta_in)

Name	Type
auth	Authentication
pageSize	xsd:int

Output (fetchDelta_out)

Name	Type
return	Return
transactions	ArrayOfTransactions
startDate	xsd:dateTime
endDate	xsd:dateTime

Loads a list of transactions that have changed since the endDate of the last fetchDelta call or the beginning of time, if the first time calling fetchDelta.

Input Fields

auth: Credentials required to authenticate this request
pageSize: Optional number of results to display per a page

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transactions: Array of transaction objects that have changed since the last time fetchDelta was called
startDate: The starting timestamp for the range of transactions found
endDate: The ending timestamp for the range of transactions found

fetchByAutobill http://soap.vindicia.com/Transaction#fetchByAutobill

Input (fetchByAutobill_in)

Name	Type
auth	Authentication
autobill	AutoBill

Output (fetchByAutobill_out)

Name	Type
return	Return
transactions	ArrayOfTransactions

Loads all transactions associated with an Autobill

Input Fields

auth: Credentials required to authenticate this request
autobill: An Autobill object

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transactions: Billing transactions automatically created for the specified Autobill

fetchSearchPage http://soap.vindicia.com/Transaction#fetchSearchPage

Input (fetchSearchPage_in)

Name	Type
auth	Authentication
VID	xsd:string
objectsPerPage	xsd:int
pageNumber	xsd:int
nameValues	ArrayOfNameValuePairs

Output (fetchSearchPage_out)

Name	Type
return	Return
transactions	ArrayOfTransactions
objectsPerPage	xsd:int
pageNumber	xsd:int

Fetch a page from a previous search

Input Fields

auth: Credentials required to authenticate this request
VID: VID of a search previously begun with searchBegin
objectsPerPage: Number of objects to return per page, maximum (and default) is 100.
pageNumber: Offset within the pages to fetch
nameValues: Optional array of name/value pairs to set on the transactions as they are fetched. Please use this with care, it is possible to quickly destroy large amounts of data with it!

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transactions: The transactions that resulted from the search
objectsPerPage: Number of objects to return per page, maximum is 100.
pageNumber: Offset within the pages being returned

auth http://soap.vindicia.com/Transaction#auth

Input (auth_in)

Name	Type
auth	Authentication
transaction	Transaction
minChargebackProbability	xsd:int
sendEmailNotification	xsd:boolean

Output (auth_out)

Name	Type
return	Return
transaction	Transaction

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.

Input Fields

auth: Credentials required to authenticate this request
transaction: The transaction object
minChargebackProbability: If Chargeback Probablity from risk scoring is greater than this, the transaction auth will fail. Default is 100 (all transactions succeed).
sendEmailNotification: Flag indicating whether an email notification should be sent upon capture of this transaction. The email notification will be sent if a template for the preferred language and corresponding email notification type is uploaded in Vindicia database as a part of merchant configuration.

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transaction: The transaction object

calculateSalesTax http://soap.vindicia.com/Transaction#calculateSalesTax

Input (calculateSalesTax_in)

Name	Type
auth	Authentication
transaction	Transaction

Output (calculateSalesTax_out)

Name	Type
return	Return
transaction	Transaction
addressType	AddressType
originalAddress	Address
correctedAddress	Address
taxItems	ArrayOfSalesTaxes
totalTax	xsd:decimal

Calculates the sales tax of the referred transaction. In order to function, at a bare minimum, the amount and one address must be available. Either the shipping address may be explicitly filled out, or the billing address may be loaded from the customer account (if any). If both are available, the shipping address is used in preference. This method has the following output return values:

'400:Must specify transaction to calculate sales tax' if no transaction specified
'400:Amount negative' if the amount on the transaction is less than zero
'404:Unable to load Account' if the specified account may not be loaded by VID or merchantAccountId

It will return 200 in all other cases.

Input Fields

auth: Credentials required to authenticate this request
transaction: The transaction object

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transaction: The transaction object, with line-item(s) for sales tax
addressType: The chosen address for tax calculation (shipping or billing)
originalAddress: The original values for the chosen address
correctedAddress: The computed values for the chosen address, after correction for inconsistencies in address
taxItems: Array of individual sales tax line items computed
totalTax: Total tax computed

capture http://soap.vindicia.com/Transaction#capture

Input (capture_in)

Name	Type
auth	Authentication
transactions	ArrayOfTransactions

Output (capture_out)

Name	Type
return	Return
qtySuccess	xsd:int
qtyFail	xsd:int
results	ArrayOfCaptureResults

Input Fields

auth: Credentials required to authenticate this request
transactions: An array of Transaction objects

Output Fields

return: Basic results of this request (success, failure, error, etc.)
qtySuccess: The number of transactions successfully captured
qtyFail: The number of transactions not successfully captured
results: An array of error codes and merchant id's for the list of transactions

cancel http://soap.vindicia.com/Transaction#cancel

Input (cancel_in)

Name	Type
auth	Authentication
transactions	ArrayOfTransactions

Output (cancel_out)

Name	Type
return	Return
qtySuccess	xsd:int
qtyFail	xsd:int
results	ArrayOfCancelResults

Input Fields

auth: Credentials required to authenticate this request
transactions: An array of Transaction objects

Output Fields

return: Basic results of this request (success, failure, error, etc.)
qtySuccess: The number of transactions successfully cancelled
qtyFail: The number of transactions not successfully cancelled
results: An array of error codes and merchant id's for the list of transactions

authCapture http://soap.vindicia.com/Transaction#authCapture

Input (authCapture_in)

Name	Type
auth	Authentication
transaction	Transaction
sendEmailNotification	xsd:boolean

Output (authCapture_out)

Name	Type
return	Return
transaction	Transaction

Input Fields

auth: Credentials required to authenticate this request
transaction: The transaction object
sendEmailNotification: Flag indicating whether an email notification should be sent upon success. The email notification will be sent if a template for the preferred language and corresponding email notification type is uploaded in Vindicia database as a part of merchant configuration.

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transaction: The transaction object

report http://soap.vindicia.com/Transaction#report

Input (report_in)

Name	Type
auth	Authentication
transactions	ArrayOfTransactions

Output (report_out)

Name	Type
return	Return

Evaluates chargeback risk score (fraud score) for the input transaction. The transaction must have billing city, billing state, billing country, and IP address at the mininum. The risk score can range for 0 (no risk) to 100 (almost certain that the transaction will result into a chargeback). This call also records the transaction in the Vindicia database.

Input Fields

auth: Credentials required to authenticate this request
transactions: An array of Transaction objects

Output Fields

return: Basic results of this request (success, failure, error, etc.)

score http://soap.vindicia.com/Transaction#score

Input (score_in)

Name	Type
auth	Authentication
transaction	Transaction

Output (score_out)

Name	Type
return	Return
transaction	Transaction
score	xsd:int
scoreCodes	ArrayOfScoreCodes

score() takes information about a transaction, and returns a score. Merchants should call this prior to authorizing the transaction, and, based upon this score, decide to either reject the transaction, go forward with it, or require the customer to provide more information. Once more information is provided, score() may be called again to retrieve a new score. This method also causes transaction information to be noted in Vindicia's system in the event of an eventual chargeback. Note that this method does not cause any actual billing to occur (i.e. no contact is made with the payment processor). Consult documentation on Vindicia's fraud screening facility for more information on how the score is computed.

Input Fields

auth: Credentials required to authenticate this request
transaction: Description of the details of the transaction

Output Fields

return: Basic results of this request (success, failure, error, etc.)
transaction: Copy of the input transaction, populated with a Vindicia generated merchant transaction id if it was not included in the input transaction
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