# Vindicia Payments Menu {% hint style="info" %} **Note:** *The `'Vindicia Capture'` feature is a licensed add-on. Please contact Naviga Support to license this feature.* {% endhint %} Vindicia is a solution for recurring billing that rectifies failed payment transactions. Vindicia Retain is designed to handle billing for auto-renew credit card transactions that the client couldn't get from the application and won't try to get from the customer or subscriber again. Using Vindicia Retain not only enables the capture of unsuccessful transactions, but it also offers subscribers an extended lifetime. Instead of a subscriber discontinuing service due to a failed transaction, Vindicia Retain may capture that transaction, enabling the site to continue billing for consecutive periods as if the site had successfully caught the transaction itself. There are three parts to the *Circulation-Vindicia* integration. 1. **Send Payments**—Sending failed payment transactions to Vindicia. 2. **Get Payments**—Obtaining an update on the status of those payments from Vindicia. 3. **Cancel or Refund Payments**—to intimate Vindicia to stop attempting to capture if the subscriber stops, if a one-time payment is received, or if a billing change occurs in order to update auto renew information. In character Circulation, select Vindicia Payments from the Accounting menu to display the Vindicia Payments Pull-out menu.
## Configuration Setup (Vindicia Business Rules) Business Rules define the maximum number of days to attempt transaction processing and the quantity of records sent or received from Vindicia. > *Section: **Setup***** > *****Rules***** > *****Business Rules***** > *****Sections***** >** [***Pymt Auth***** - *****Vindicia***](https://docs.navigaglobal.com/circulation-setup-manual/business-rules/pymt-auth-vindicia) 1. **What is the SOAP API URL to access Vindicia Retain?**\ Enter the URL to access the SOAP API. This value is provided by the Vindicia implementation team. 2. **What is the userid to access Vindicia Retain?**\ Enter the user ID here. This value is provided by the Vindicia implementation team. 3. **What is the key to access Vindicia Retain?**\ Enter the Key ID here. This value is provided by the Vindicia implementation team. 4. **What is the API version to access Vindicia Retain?**\ Indicate which API version is to be used to access Vindicia Retain. For example, 1.1. 5. **What is the maximum number of days Vindicia Retain will try transaction processing?**\ \&#xNAN;*Default Value:* **7**\ This BR specifies the number of days we will allow Vindicia to attempt a failed payment on their end. When this number of days has elapsed, we consider that the payment was not successfully captured by Vindicia and make the required system updates. 6. **What is the limit for records in one file sent or received from Vindicia Retain?**\ \&#xNAN;*Default Value:* **200**\ This BR specifies the number of records we will get in a single file when we retrieve the payment records from Vindicia. 7. **What Delivery Types of the Subscriptions should be allowed to send to Vindicia?**\ \&#xNAN;*Default Value:* **Both** This BR determines which subscriptions with a suspended billing change transaction are eligible to be sent to Vindicia. Available values: * **Print** * **Digital** * **Both** Based on the selected value, only subscriptions matching the defined Delivery Type will be included when failed AutoPay credit card transactions are sent to Vindicia. ## Send Payments This is used to send information about unsuccessful payment transactions to Vindicia. #### To send payments to Vindicia: 1. Go to *Character Accounting > Vindicia Payments > Send Payments*.
2. Select **Add** and enter the **Cutoff Date**. The system will choose all failed Auto Payment credit card records with payment dates up to this cutoff date. 3. Select **Continue** to send the payments to Vindicia.
4. After the records have been processed, Vindicia will return an acknowledgment, indicating whether the request was successful or had any errors. A typical acknowledgement response is as follows:
*** ## Get Payments This is used to determine the status of the unsuccessful transaction records that we send to Vindicia in the Send payments functionality. Vindicia will attempt to process the unsuccessful transactions for the number of days specified in the BR—***What is the maximum number of days Vindicia Retain will try transaction processing?*** (*Pymt Auth - Vindicia* section) before providing the status of the transactions to our system. When Vindicia makes a successful payment, the subscriber's suspended billing change transaction is deleted, and a payment transaction is created to indicate that the payment was successfully completed. If Vindicia is unable to process a successful payment for a record, the suspended billing change transaction for that subscriber is deleted, and the subscription will now be discontinued from AutoPay. When **Vindicia** successfully processes a payment and the status is retrieved using **Get Payments**, the **Transaction ID** field on the **Payment Information** screen for the **SubscriptionPayment** record in **Customer Services** is populated automatically. The **Transaction ID** is populated with the **NameValuePair (NVP)** value of **PaymentProcessorTransactionId** returned in the **FetchBill** response from Vindicia. This allows the payment record in Circulation to store the corresponding transaction identifier received from the Vindicia payment processor. {% hint style="info" %} **Note:** * *The suspended billing change transaction cannot be modified or deleted, and the options are disabled until the **Vindicia Retain** process is completed.* * *The billing change transaction can be deleted only if the status returned after the Vindicia Retain process is 'Failed', 'Cancelled', or 'Refunded'.* {% endhint %} #### To get payments from Vindicia: 1. Go to *Character Accounting > Vindicia Payments > Get Payments.*
2. Select **Add** and complete the following fields.
FieldTypeWhat to enter
START DATE,
END DATE		dateEnter the date range for fetching the status of the records sent to Vindicia.
PAGE SIZEinteger (3)Enter the maximum number of records on one page to be fetched.
PAGE NUMBERinteger (7)Enter the page number at which all created pages will be received.
For example, if Vindicia has processed 740 records and the Page Size is set to 100, entering Page Number as 0 would return 8 files sequentially, with 100 records on each page from Page 0 through Page 6, and 40 records on Page 7.
3. Select **Continue** to fetch the status of the records from Vindicia.
4. After the records have been processed, Vindicia will return an acknowledgment, indicating whether the request was successful or had any errors. A typical fetch response is as follows:
*** ## Cancel Payments This is used to send refunds or cancel responses to the payment requests that were sent to Vindicia. If Vindicia processes the refund/cancel request before making a successful payment against a record, Vindicia will no longer attempt to make payment for the record and the status of the record will be **Cancelled**. However, if Vindicia processes a refund/cancel request after the payment against that record is successfully processed, the payment must be refunded by Vindicia, and the status of the record will be **Refunded**. If a subscriber chooses to Permanently Stop a Subscription after submitting unsuccessful transactions to Vindicia, a refund/cancel request will be sent, which will either cancel the payment or stop the payment attempt. #### To cancel or refund payments: 1. Go to *Character Accounting > Vindicia Payments > Cancel Payments.*
2. Select **Add** and enter the **Cutoff Date**. The system will choose all failed Auto Payment credit card records with payment dates up to this cutoff date. 3. Select **Continue** to send cancel or refund request to Vindicia.
4. After the records have been processed, Vindicia will return an acknowledgment, indicating whether the request was successful or had any errors. A typical acknowledgement response is as follows:
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.navigaglobal.com/circulation-user-manual/accounting/vindicia-payments-menu.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.