Skip to main content
The core Retain Methods include the following:
  • billTransactions—(required) submit failed transactions to Retain for processing
  • fetchBillingResults— (required) retrieve final results of Retain processing
  • refundTransactions— (optional) cancel/refund a transaction submitted to Retain
  • addPaymentMethods - (optional) add additional payment methods to retries for failed transactions
Implementations of core Retain Methods are evaluated during merchant Retain Certification. Refer to the respective Use Cases for the required implementation for Certification. See the Transaction Data Members and the Payment Method Data Members for information about the values passed to and returned by the Retain Methods.

​
Example Programs Calling Vindicia Retain Methods

Example programs in C#, Java, PHP and Python that demonstrate using the Retain Methods are available on github. An example in Ruby is also available on github.

​
Pseudo Code for Calling Vindicia Retain Methods

Although pseudo code for calling Vindicia Retain Methods is provided with the Methods described below, this API Guide is primarily a reference, and as such is more concerned with describing the inputs and outputs of the Methods than with how they should be used in an application. For more information about what Retain Certification expects in your implementation, follow the links to the associated Use Case in each of the required methods. The following table summarizes the methods for Vindicia Retain.