Skip to main content
To get started with Vindicia Retain, you’ll need to submit your failed Transactions to the system. Using the Retain REST API, you can submit these failed transactions and Vindicia will retry capturing them and recovering the lost revenue.
  1. Submit your failed Transaction to Retain using the POST /retain/transactions call. You can submit arrays of failed transactions from your billing system to Vindicia Retain up to 1000 transactions per batch. Retain then runs its smart retry algorithms according to your configured settings and tries to capture and recover the submitted Transactions. Note: For merchants that enabled forced deposit, you can specify that a specific Transaction not undergo forced capture (such as initial Transaction on a new subscription) by submitting the transaction with previous_billing_count a attribute value set to -1. Vindicia returns a success message for transactions that are accepted and can be processed and validation errors for the transaction that could not be accepted and will not be processed.
  2. Receive secondary system validation errors (exceptions) that are returned for the submitted Transactions by listening to Push Notifications (webhooks) or as a csv file in the Retain Hub submission History page. For more details on error codes and troubleshooting, see Retain Transaction Submission Errors.
  3. Receive Transaction results by fetching from GET retain/transactions or by listening to Push Notifications (webhooks) sent by Retain. The returned results from this call include any new payment method information available as a result of the Account Updater process. Vindicia Retain encrypts the card using the public key before returning it to you. If the payment method did not change, it does not pass any value in this field. Note:
    • To use the Vindicia Retain Account Updater, you must submit a PGP public key for encryption of any returned credit card information. Vindicia Retain uses this key to encrypt credit card numbers for return in the GET /retain/transactions call. You must also have completed an Attestation of Compliance (AOC) as a declaration of the results of the service provider’s assessment with the Payment Card Industry Data Security Standards (PCI DSS). Work with your Vindicia Client Technical Support representative to enable Account Updater with Vindicia Retain
    • To learn more about Push Notifications and their setup, See Push Notifications chapter in the Feature Implementation Guide.
  4. Stop a submitted Transaction from attempting additional retries or Refund (fully or partially) a captured Transaction, by calling POST retain/refunds.