PaymentMethod          


Methods        

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

Input (update_in)
Name Type
auth Authentication
paymentMethod PaymentMethod
validate xsd:boolean
minChargebackProbability xsd:int
replaceOnAllAutoBills xsd:boolean

Output (update_out)

Name Type
return Return
paymentMethod PaymentMethod
created xsd:boolean
validated xsd:boolean

Creates a new PaymentMethod object or updates an existing one.

Input Fields

auth
Credentials required to authenticate this request
paymentMethod
Object to create
validate
Whether to just update or validate first
minChargebackProbability
If Chargeback Probablity from risk scoring is greater than this, the transaction will fail. Default is 100 (all payment methods are applied).
replaceOnAllAutoBills
Set to true if you want the updates to the payment method to propagate to all autobills using this payment method. Defaults to false meaning no autobills will be updated

Output Fields

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

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

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

Output (fetchByVid_out)

Name Type
return Return
paymentMethod PaymentMethod

Loads a PaymentMethod by Vindicia's unique 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.)
paymentMethod
The resultant object

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

Input (fetchByAccount_in)
Name Type
auth Authentication
account Account

Output (fetchByAccount_out)

Name Type
return Return
paymentMethods ArrayOfPaymentMethods

Loads a list of PaymentMethods by the Account that owns them

Input Fields

auth
Credentials required to authenticate this request
account
Account for which to retrieve associated PaymentMethods. Account object should have at least one of VID or merchantAccountId set (if both are set, VID is checked first).

Output Fields

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

fetchByMerchantPaymentMethodId http://soap.vindicia.com/PaymentMethod#fetchByMerchantPaymentMethodId

Input (fetchByMerchantPaymentMethodId_in)
Name Type
auth Authentication
paymentMethodId xsd:string

Output (fetchByMerchantPaymentMethodId_out)

Name Type
return Return
paymentMethod PaymentMethod

Loads a PaymentMethod by Merchant's unique ID for the payment method

Input Fields

auth
Credentials required to authenticate this request
paymentMethodId
Merchant ID for the payment method

Output Fields

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

validate http://soap.vindicia.com/PaymentMethod#validate

Input (validate_in)
Name Type
auth Authentication
paymentMethod PaymentMethod

Output (validate_out)

Name Type
return Return
validated xsd:boolean

Validates - but does NOT store - a PaymentMethod, and assures it's basically correct.

Input Fields

auth
Credentials required to authenticate this request
paymentMethod
The PaymentMethod to validate.

Output Fields

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