Account

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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