Account          


Methods        

update http://soap.vindicia.com/v16_0/Account#update

Input (update_in)
Name Type
auth Authentication
srd xsd:string
account Account

Output (update_out)

Name Type
return Return
account Account (optional)
created xsd:boolean

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

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The Account class object

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
The Account class object
created
True if the object was created new

stopAutoBilling http://soap.vindicia.com/v16_0/Account#stopAutoBilling

Input (stopAutoBilling_in)
Name Type
auth Authentication
srd xsd:string
account Account
autobills AutoBill (0 or more)
disentitle xsd:boolean
force xsd:boolean

Output (stopAutoBilling_out)

Name Type
return Return
account Account (optional)

Cancels and optionally dis-entitles a specified or all AutoBill objects for an Account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account object
autobills
The autobills to be cancelled. If none specified, cancels all AutoBills.
disentitle
If true, also immediately disentitles the Account for relevant Products.
force
If true, allows cancelling even if within a defined commitment period.

Output Fields

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

updatePaymentMethod http://soap.vindicia.com/v16_0/Account#updatePaymentMethod

Input (updatePaymentMethod_in)
Name Type
auth Authentication
srd xsd:string
account Account
paymentMethod PaymentMethod
replaceOnAllAutoBills xsd:boolean
updateBehavior PaymentUpdateBehavior
ignoreAvsPolicy xsd:boolean (optional)
ignoreCvnPolicy xsd:boolean (optional)

Output (updatePaymentMethod_out)

Name Type
return Return
account Account (optional)
validated xsd:boolean

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.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account object
paymentMethod
Method to add
replaceOnAllAutoBills
If true, replaces the autobilling on all this Account's AutoBills
updateBehavior
Whether to just update, validate first, or catch up billing first
ignoreAvsPolicy
Set to 1, to not evaluate any custom or default avs policy.
ignoreCvnPolicy
Set to 1, to not evaluate any custom or default cvn policy.

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
The account object
validated
True if the payment method was successfully validated

fetchByMerchantAccountId http://soap.vindicia.com/v16_0/Account#fetchByMerchantAccountId

Input (fetchByMerchantAccountId_in)
Name Type
auth Authentication
srd xsd:string
merchantAccountId xsd:string

Output (fetchByMerchantAccountId_out)

Name Type
return Return
account Account (optional)

Loads an account by the merchant's unique customer ID

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
merchantAccountId
Merchant ID for the customer

Output Fields

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

fetchByVid http://soap.vindicia.com/v16_0/Account#fetchByVid

Input (fetchByVid_in)
Name Type
auth Authentication
srd xsd:string
vid xsd:string

Output (fetchByVid_out)

Name Type
return Return
account Account (optional)

Loads an account by Vindicia's unique ID for the account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
vid
Vindicia ID for the customer

Output Fields

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

fetchByWebSessionVid http://soap.vindicia.com/v16_0/Account#fetchByWebSessionVid

Input (fetchByWebSessionVid_in)
Name Type
auth Authentication
srd xsd:string
vid xsd:string

Output (fetchByWebSessionVid_out)

Name Type
return Return
account Account (optional)

Loads an account by WebSession's unique ID

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
vid
Vindicia ID for the WebSession object

Output Fields

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

fetchByEmail http://soap.vindicia.com/v16_0/Account#fetchByEmail

Input (fetchByEmail_in)
Name Type
auth Authentication
srd xsd:string
emailAddress xsd:string

Output (fetchByEmail_out)

Name Type
return Return
accounts Account (0 or more)

Loads an account by an email address

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
emailAddress
Address to load by

Output Fields

return
Basic results of this request (success, failure, error, etc.)
accounts
The account objects

fetchCreatedSince http://soap.vindicia.com/v16_0/Account#fetchCreatedSince

Input (fetchCreatedSince_in)
Name Type
auth Authentication
srd xsd:string
timestamp xsd:dateTime
endTimestamp xsd:dateTime
page xsd:int (optional)
pageSize xsd:int (optional)

Output (fetchCreatedSince_out)

Name Type
return Return
accounts Account (0 or more)

Loads a list of accounts that are created since a timestamp

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
timestamp
All accounts on or after this timestamp
endTimestamp
All accounts before this timestamp, optional - defaults to todays date
page
Optional page number to begin results returned.
pageSize
Optional number of results to display per page .

Output Fields

return
Basic results of this request (success, failure, error, etc.)
accounts
Array of Account objects matching the search criteria

fetchByPaymentMethod http://soap.vindicia.com/v16_0/Account#fetchByPaymentMethod

Input (fetchByPaymentMethod_in)
Name Type
auth Authentication
srd xsd:string
paymentMethod PaymentMethod
page xsd:int
pageSize xsd:int

Output (fetchByPaymentMethod_out)

Name Type
return Return
accounts Account (0 or more)

This method will return a list of accounts that have the specified payment method associated with them. The The input PaymentMethod object need not be fully populated. If VID is specified in the input PaymentMethod object, it will be used as the primary identifying factor for the payment method record to be used as the search criterion. If VID is not specified in the input PaymentMethod object, merchantPaymentMethodId will be used as the primary identifying factor for the payment method record to be used as the search criterion. If both VID, and merchantPaymentMethod are absent, account number for a Credit Card, account number - bank routing number combination for ACH/ECP, fiscal number used for a Boleto payment will be used as the search criterion depending on type specified in the input PaymentMethod object. Since PayPal transactions processed through CashBox have no unique identifier, all accounts that use PayPal will be returned. Merchants should use the paging parameters to limit the number of records returned per call

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
paymentMethod
Payment method to use as search criterion
page
Page number to begin results returned. First page number is 0
pageSize
Number of results to display per page, should be more than 0

Output Fields

return
Basic results of this request (success, failure, error, etc.)
accounts
Array of Account objects matching the search criteria

tokenBalance http://soap.vindicia.com/v16_0/Account#tokenBalance

Input (tokenBalance_in)
Name Type
auth Authentication
srd xsd:string
account Account
tokens Token (0 or more)

Output (tokenBalance_out)

Name Type
return Return
tokenAmounts TokenAmount (0 or more)

Returns a customer's balance of tokens of the requested type, or all types attached to the account if none are specified

Has the following return values:

'404:Token not found' One or more tokens specified is not a saved type; all transactions are aborted, and the tokens are not created or transferred.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account for which token balance is to be obtained
tokens
Token(s) balance is requested for, if not specified all tokens attached to the account will be returned

Output Fields

return
Basic results of this request (success, failure, error, etc.)
tokenAmounts
The customer's resultant balances specified or all token types

tokenTransaction http://soap.vindicia.com/v16_0/Account#tokenTransaction

Input (tokenTransaction_in)
Name Type
auth Authentication
srd xsd:string
account Account
transactions TokenTransaction (0 or more)

Output (tokenTransaction_out)

Name Type
return Return
tokenAmounts TokenAmount (0 or more)

Performs one or more token transactions on an account. These transactions may be on multiple token types, and may be positive (increasing token balance) or negative (reducing token balance).

Has the following return values:

'401:Balance too low' One or more transaction requested would drop the user's balance below 0
'404:Token not found' One or more tokens specified is not a saved type; the tokens available on the account are still returned, however.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account for which this transaction is to be conducted
transactions
A set of token transactions to be performed against the user's account

Output Fields

return
Basic results of this request (success, failure, error, etc.)
tokenAmounts
New balances for each changed token

incrementTokens http://soap.vindicia.com/v16_0/Account#incrementTokens

Input (incrementTokens_in)
Name Type
auth Authentication
srd xsd:string
account Account
tokenAmounts TokenAmount (0 or more)

Output (incrementTokens_out)

Name Type
return Return
tokenAmounts TokenAmount (0 or more)

Performs one or more token transactions on an account. These transactions may be on multiple token types. This method is equivalent to tokenTransaction with a negative value for token amount(s).

Has the following return values:

'404:Token not found' One or more tokens specified is not a saved type; the tokens available on the account are still returned, however.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this token transaction applies
tokenAmounts
A set of token amounts to be added to the user's account

Output Fields

return
Basic results of this request (success, failure, error, etc.)
tokenAmounts
New balances for each changed token

decrementTokens http://soap.vindicia.com/v16_0/Account#decrementTokens

Input (decrementTokens_in)
Name Type
auth Authentication
srd xsd:string
account Account
tokenAmounts TokenAmount (0 or more)

Output (decrementTokens_out)

Name Type
return Return
tokenAmounts TokenAmount (0 or more)

Performs one or more token transactions on an account. These transactions may be on multiple token types. This method is equivalent to tokenTransaction with a positive value for token amount(s).

Has the following return values:

'401:Balance too low' One or more requested token decrements would drop the user's balance below 0
'404:Token not found' One or more tokens specified is not a saved type; the tokens available on the account are still returned, however.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this token transaction applies
tokenAmounts
A set of token amounts to be subtracted from the user's account

Output Fields

return
Basic results of this request (success, failure, error, etc.)
tokenAmounts
New balances for each changed token

transfer http://soap.vindicia.com/v16_0/Account#transfer

Input (transfer_in)
Name Type
auth Authentication
srd xsd:string
targetAccount Account
sourceAccount Account

Output (transfer_out)

Name Type
return Return
mergedAccount Account (optional)

Merges target account with a given (source) account and returns the target account with merged contents. Both accounts specified as input to this call must exist in the CashBox system otherwise an error will be returned. This method transfers payment methods, chargebacks, tax exemptions, autobills, activities, token grants and deductions, transactions, and name-value pairs associated with the source account into the target account. Additionally, it creates two name-value pairs with names VIN_MERCHANT_CUSTOMER_ID_UPDATED_FROM and VIN_MERCHANT_CUSTOMER_ID_UPDATED_DATE in each of the autobill object transferred indicating the original merchantCustomerId the autobill was associated with and the date on which it was transferred. The source account is stripped of all of the above contents but will continue to exist in the system with some basic attributes.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
targetAccount
Target account into which the contents of the two accounts will be merged
sourceAccount
Account to be merged with the target account

Output Fields

return
Basic results of this request (success, failure, error, etc.)
mergedAccount
Target account with merged contents of the two input accounts

redeemGiftCard http://soap.vindicia.com/v16_0/Account#redeemGiftCard

Input (redeemGiftCard_in)
Name Type
auth Authentication
srd xsd:string
account Account
giftcard GiftCard
credit xsd:int (optional)

Output (redeemGiftCard_out)

Name Type
return Return
giftcard GiftCard (optional)
account Account (optional)

Redeems gift card for an account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this gift card redemption applies
giftcard
The gift card being redeemed
credit
Number of credits to be redeemed from gift card (CURRENTLY UNSUPPORTED)

Output Fields

return
Basic results of this request (success, failure, error, etc.)
giftcard
Gift card that was redeemed with updated status
account
Account with updated credit as granted by gift card redemption

grantCredit http://soap.vindicia.com/v16_0/Account#grantCredit

Input (grantCredit_in)
Name Type
auth Authentication
srd xsd:string
account Account
credit Credit
note xsd:string (optional)

Output (grantCredit_out)

Name Type
return Return
account Account (optional)

Grant credit to an account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this credit grant applies
credit
Credits to be granted
note
Note regarding credit being granted

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
Account with new credit balances for each changed credit

revokeCredit http://soap.vindicia.com/v16_0/Account#revokeCredit

Input (revokeCredit_in)
Name Type
auth Authentication
srd xsd:string
account Account
credit Credit
note xsd:string (optional)

Output (revokeCredit_out)

Name Type
return Return
account Account (optional)

Decrement credits from an account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this credit decrement applies
credit
Credits to be decremented
note
Note regarding credit being revoked

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
Account with new credit balances for each changed credit

fetchCreditHistory http://soap.vindicia.com/v16_0/Account#fetchCreditHistory

Input (fetchCreditHistory_in)
Name Type
auth Authentication
srd xsd:string
account Account (optional)
timestamp xsd:dateTime (optional)
endTimestamp xsd:dateTime
page xsd:int
pageSize xsd:int

Output (fetchCreditHistory_out)

Name Type
return Return
creditEventLogs CreditEventLog (0 or more)

Fetch credit grant/decrement history for an account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The Account to which this request applies
timestamp
All credit events on or after this timestamp
endTimestamp
All credit events before this timestamp
page
Optional page number to begin results returned
pageSize
Optional number of results to display per a page

Output Fields

return
Basic results of this request (success, failure, error, etc.)
creditEventLogs
Credit events (grants/deductions), with timestamp and event type

fetchAllCreditHistory http://soap.vindicia.com/v16_0/Account#fetchAllCreditHistory

Input (fetchAllCreditHistory_in)
Name Type
auth Authentication
srd xsd:string
timestamp xsd:dateTime (optional)
endTimestamp xsd:dateTime
page xsd:int
pageSize xsd:int

Output (fetchAllCreditHistory_out)

Name Type
return Return
creditEventLogs CreditEventLog (0 or more)

Fetch credit grant/decrement history for all accounts

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
timestamp
All credit events on or after this timestamp
endTimestamp
All credit events before this timestamp
page
Optional page number to begin results returned
pageSize
Optional number of results to display per a page

Output Fields

return
Basic results of this request (success, failure, error, etc.)
creditEventLogs
Credit events (grants/deductions), with timestamp and event type

addChildren http://soap.vindicia.com/v16_0/Account#addChildren

Input (addChildren_in)
Name Type
auth Authentication
srd xsd:string
parent Account
child Account (0 or more)
force xsd:boolean (optional)
payerReplacementBehavior AccountPayerReplacementBehavior (optional)

Output (addChildren_out)

Name Type
return Return
childAdded Account (0 or more)

Add one or more child accounts to a parent account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
parent
The Account that should be parent to these children
child
The child or children that should be attached to this parent account
force
If set, replace any parents that these children may already have
payerReplacementBehavior
Controls how existing AutoBills of the children are affected

Output Fields

return
Basic results of this request (success, failure, error, etc.)
childAdded
The child or children added

removeChildren http://soap.vindicia.com/v16_0/Account#removeChildren

Input (removeChildren_in)
Name Type
auth Authentication
srd xsd:string
parent Account
child Account (0 or more)
payerReplacementBehavior AccountPayerReplacementBehavior (optional)

Output (removeChildren_out)

Name Type
return Return

Delete one or more child accounts from a parent account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
parent
The Account that should be parent to these children
child
The child or children that should be deleted from this parent account
payerReplacementBehavior
Controls how existing AutoBills of the children are affected

Output Fields

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

fetchFamily http://soap.vindicia.com/v16_0/Account#fetchFamily

Input (fetchFamily_in)
Name Type
auth Authentication
srd xsd:string
account Account

Output (fetchFamily_out)

Name Type
return Return
parent Account
child Account (0 or more)

Return the family of the given account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account that you want to look up the family for

Output Fields

return
Basic results of this request (success, failure, error, etc.)
parent
The parent Account for this family
child
The child or children in this family

transferCredit http://soap.vindicia.com/v16_0/Account#transferCredit

Input (transferCredit_in)
Name Type
auth Authentication
srd xsd:string
fromAccount Account
toAccount Account
credit Credit

Output (transferCredit_out)

Name Type
return Return

Transfer credits from one account to another

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
fromAccount
The parent Account to transfer credits from
toAccount
The child account to transfer credits to
credit
Credits to be transferred

Output Fields

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

makePayment http://soap.vindicia.com/v16_0/Account#makePayment

Input (makePayment_in)
Name Type
auth Authentication
srd xsd:string
account Account
paymentMethod PaymentMethod
amount xsd:decimal
currency xsd:string (optional)
invoiceId xsd:string
overageDisposition PaymentOverageDisposition (optional)
note xsd:string (optional)

Output (makePayment_out)

Name Type
return Return
transaction Transaction (optional)
summary TransactionAttemptSummary (optional)

makes a payment against an Account/AutoBill

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this payment applies
paymentMethod
The PaymentMethod used for this Payment.
amount
Amount to pay.
currency
ISO 4217 currency code for amount. This must match the currency used for charges on the current invoice (if not specified, the AutoBill/Invoice currency will be used).
invoiceId
ID of Invoice to make payment against.
overageDisposition
How to disposition amounts in excess of a required AutoBill payment amount. Defaults to applyToOldestInvoice if not specified
note
Note regarding payment being made

Output Fields

return
Basic results of this request (success, failure, error, etc.)
transaction
The transaction generated by the payment attempt. This transaction must be inspected to assess the details of the payment attempt.
summary
Summary of payment attempt

reversePayment http://soap.vindicia.com/v16_0/Account#reversePayment

Input (reversePayment_in)
Name Type
auth Authentication
srd xsd:string
account Account
timestamp xsd:dateTime (optional)
paymentId xsd:string (optional)
invoiceId xsd:string (optional)
indexNumber xsd:int (optional)
note xsd:string (optional)

Output (reversePayment_out)

Name Type
return Return

Reverses an Account/AutoBill payment. This may only be used with payments using MerchantAcceptedPayment PaymentMethods.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this reversal applies
timestamp
Time that payment reversal occurred
paymentId
The paymentId of the MerchantAcceptedPayment used for this Payment. Either the paymentID, or the invoiceID (and optional indexNumber) must be specified.
invoiceId
ID of Invoice associated with the payment reversal. Either the paymentID, or the invoiceID (and optional indexNumber) must be specified.
indexNumber
IndexNumber of the payment item (on the invoiceID invoice) that is being reversed.
note
Note regarding payment being reversed

Output Fields

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

isEntitled http://soap.vindicia.com/v16_0/Account#isEntitled

Input (isEntitled_in)
Name Type
auth Authentication
srd xsd:string
account Account
merchantEntitlementId xsd:string

Output (isEntitled_out)

Name Type
return Return
entitled xsd:boolean (optional)

Determines whether or not an account has an entitlement. This will check account entitlements, as well as entitlements associated with the account AutoBills.

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account for which the check is to be performed
merchantEntitlementId
The merchant's unique ID for this entitlement

Output Fields

return
Basic results of this request (success, failure, error, etc.)
entitled
Set to true if the customer is entitled

grantEntitlement http://soap.vindicia.com/v16_0/Account#grantEntitlement

Input (grantEntitlement_in)
Name Type
auth Authentication
srd xsd:string
account Account
entitlement Entitlement
note xsd:string (optional)

Output (grantEntitlement_out)

Name Type
return Return
account Account (optional)

Grants entitlement to an account

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this grant applies
entitlement
Entitlement for a given Account
note
Note regarding entitlement being granted

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
Account with new entitlements

revokeEntitlement http://soap.vindicia.com/v16_0/Account#revokeEntitlement

Input (revokeEntitlement_in)
Name Type
auth Authentication
srd xsd:string
account Account
entitlement Entitlement (optional)
merchantEntitlementId xsd:string (optional)
note xsd:string (optional)

Output (revokeEntitlement_out)

Name Type
return Return
account Account (optional)

Revokes entitlement from an account (Note: This will not revoke AutoBill entitlements)

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this revocation applies
entitlement
Entitlement for a given Account
merchantEntitlementId
The merchant's unique ID for this entitlement. This may be specified in lieu of the full Entitlement object. Note that Either the Entitlement or the merchantEntitlementId must be specified.
note
Note regarding entitlement revocation

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
Account with modified entitlements

extendEntitlementToDate http://soap.vindicia.com/v16_0/Account#extendEntitlementToDate

Input (extendEntitlementToDate_in)
Name Type
auth Authentication
srd xsd:string
account Account
entitlement Entitlement (optional)
merchantEntitlementId xsd:string (optional)
extensionDate xsd:dateTime
note xsd:string (optional)

Output (extendEntitlementToDate_out)

Name Type
return Return
account Account (optional)

Extends an account entitlement to the date provided

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this extension applies
entitlement
Entitlement for a given Account
merchantEntitlementId
The merchant's unique ID for this entitlement. This may be specified in lieu of the full Entitlement object. Note that Either the Entitlement or the merchantEntitlementId must be specified.
extensionDate
New end time for entitlement
note
Note regarding entitlement extension

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
Account with modified entitlements

extendEntitlementByInterval http://soap.vindicia.com/v16_0/Account#extendEntitlementByInterval

Input (extendEntitlementByInterval_in)
Name Type
auth Authentication
srd xsd:string
account Account
entitlement Entitlement (optional)
merchantEntitlementId xsd:string (optional)
interval TimeInterval
note xsd:string (optional)

Output (extendEntitlementByInterval_out)

Name Type
return Return
account Account (optional)

Extends an account entitlement by the interval provided

Input Fields

auth
Credentials required to authenticate this request
srd
sparse return descriptor
account
The account to which this extension applies
entitlement
Entitlement for a given Account
merchantEntitlementId
The merchant's unique ID for this entitlement. This may be specified in lieu of the full Entitlement object. Note that Either the Entitlement or the merchantEntitlementId must be specified.
interval
Extension interval to be applied to entitlement
note
Note regarding entitlement extension

Output Fields

return
Basic results of this request (success, failure, error, etc.)
account
Account with modified entitlements