Skip to main content
Returns an array of completed transactions. Only those transactions that have reached a terminal status (Captured, Canceled, Refunded, or Failed) during the time period specified are returned. This call is required to implement Retain use case 5-8-02. Note: Vindicia Retain requires that input parameters be entered in the order shown, and place-marked with null if not specified. Paging is supported using page and pageSize. Continue calling the function until the length of the resulting array is 0. Note: To use the Vindicia Retain Account Updater during Deployment, contact your Vindicia Solutions Architect; after go-live, contact Vindicia Customer Support. 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). You must provide a PGP public key to Vindicia to encrypt returned credit card information.

​
Input

timestamp: the starting timestamp for the range of (terminal state) Transactions you want to retrieve. endTimestamp: the ending timestamp for the range of (terminal state) Transactions you want to retrieve. page: the page number, starting at 0, for which to return the results. For example, if the total number of results is 85 and pageSize is 10:
  • Specifying 0 for page gets the results from 1 through 10.
  • Specifying 2 for page gets the results from 21 through 30.
pageSize: the number of records to display per page per call. This value must be greater than 0.

​
Output

return: an object of type Return that indicates the success or failure of the call. transactions: an array of Transaction objects that have reached a terminal status during the time period specified with timestamp and endTimestamp. Note: Each Transaction object returned will identify the original transaction submitted via the merchantTransactionId and the last transaction processed as the selectTransactionId. Thus, terminal results for every transaction submitted on a given day should have been retrieved by or as of the fetch following the final retry.

​
Returns

This method returns the codes listed in Retain Return Codes. Parent topic:Vindicia Retain Methods