Account

Methods

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

Input (update_in)

Name	Type
auth	Authentication
account	Account

Output (update_out)

Name	Type
return	Return
account	Account
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
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/Account#stopAutoBilling

Input (stopAutoBilling_in)

Name	Type
auth	Authentication
account	Account
autobills	ArrayOfAutoBills
disentitle	xsd:boolean
force	xsd:boolean

Output (stopAutoBilling_out)

Name	Type
return	Return
account	Account

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

Input Fields

auth: Credentials required to authenticate this request
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/Account#updatePaymentMethod

Input (updatePaymentMethod_in)

Name	Type
auth	Authentication
account	Account
paymentMethod	PaymentMethod
replaceOnAllAutoBills	xsd:boolean
updateBehavior	PaymentUpdateBehavior
numCycles	xsd:int

Output (updatePaymentMethod_out)

Name	Type
return	Return
account	Account
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
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
numCycles: Number of cycles to catch up if updateBehavior is set to CatchUp. If numCycles is <= 0 then all outstanding billings are charged.

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/Account#fetchByMerchantAccountId

Input (fetchByMerchantAccountId_in)

Name	Type
auth	Authentication
merchantAccountId	xsd:string

Output (fetchByMerchantAccountId_out)

Name	Type
return	Return
account	Account

Loads an account by the merchant's unique customer ID

Input Fields

auth: Credentials required to authenticate this request
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/Account#fetchByVid

Input (fetchByVid_in)

Name	Type
auth	Authentication
vid	xsd:string

Output (fetchByVid_out)

Name	Type
return	Return
account	Account

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

Input Fields

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

Output Fields

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

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

Input (fetchByEmail_in)

Name	Type
auth	Authentication
emailAddress	xsd:string

Output (fetchByEmail_out)

Name	Type
return	Return
accounts	ArrayOfAccounts

Loads an account by an email address

Input Fields

auth: Credentials required to authenticate this request
emailAddress: Address to load by

Output Fields

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

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

Input (tokenBalance_in)

Name	Type
auth	Authentication
account	Account
tokens	ArrayOfTokens

Output (tokenBalance_out)

Name	Type
return	Return
tokenAmounts	ArrayOfTokenAmounts

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
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/Account#tokenTransaction

Input (tokenTransaction_in)

Name	Type
auth	Authentication
account	Account
transactions	ArrayOfTokenTransactions

Output (tokenTransaction_out)

Name	Type
return	Return
tokenAmounts	ArrayOfTokenAmounts

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
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/Account#incrementTokens

Input (incrementTokens_in)

Name	Type
auth	Authentication
account	Account
tokenAmounts	ArrayOfTokenAmounts

Output (incrementTokens_out)

Name	Type
return	Return
tokenAmounts	ArrayOfTokenAmounts

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
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/Account#decrementTokens

Input (decrementTokens_in)

Name	Type
auth	Authentication
account	Account
tokenAmounts	ArrayOfTokenAmounts

Output (decrementTokens_out)

Name	Type
return	Return
tokenAmounts	ArrayOfTokenAmounts

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
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