Skip to main content
Vindicia Knowledge Center

Mapping Response Data Fields for Vindicia Retain

Mapping Response Data Fields for Vindicia Retain

User Story

Merchant developer or architect needs to identify the Transaction data resulting from Vindicia Retain processing and map this data back to the merchant system.  Merchant system can use this data to update the subscriber status and identify follow-up actions as appropriate (see Update Merchant System With Vindicia Retain Results SEL-010).



  • Failed transactions have been submitted to Vindicia Retain for processing and results have been retrieved from Vindicia Retain.
  • Merchant system has a means of tracking billing status for transactions submitted to Vindicia Retain.
  • Result data retrieved from Vindicia Retain is stored appropriately in merchant system for follow-up with the subscriber.
  • Merchant business user has access to data to locate recovered transactions in payment processor portal.

Basic Scenario

  1. Inform the merchant business user of the returned data on failed transactions processed with Vindicia Retain.
  2. Update merchant destination data fields with the returned Vindicia Retain data.
  3. Update the subscriber account for the transaction as appropriate.

Design Approach

1. Inform the merchant business user on the availability of returned data that will be stored in the merchant system. The selectTransactionId  contains the Order ID/Number in the payment processor portal.

2. Identify destination data in the merchant system that will be updated from the returned Vindicia Retain transaction data members, using the associated mapping from Vindicia Retain data members returned to merchant destination data fields.

3. Confirm with the merchant business user that a process exists which will use the returned data stored in the merchant system to appropriately update the subscriber account, either keeping the subscriber entitled when the failed transaction has been recovered by Vindicia Retain, or following up with the subscriber otherwise.

Sequence Diagram

Not Applicable

Use Case Implementation

  1. The fields in the table below are always returned on the transaction object as output with the results of Vindicia Retain processing:
Vindicia Retain Data Field Corresponding Merchant Data Value
amount Monetary value for the transaction.
authCode The authorization response code (i.e. 302, 530, etc.) returned by payment processor for the most recent Failed authorization decline.
avsCode The AVS (Address Verification) result for the Billing Address for the final Transaction attempt by Select.
currency Currency code for Transaction object. Default is USD.
customerId Unique ID of the customer's account.
divisionNumber The merchant's division or group number, used by payment processor when processing the original Transaction. Chase Paymentech refers to this number as the Division Number; Litle calls it the Report Group; MeS calls it the Profile ID. 
merchantTransactionId Unique ID of failed transaction, as originally provided when submitted to Vindicia Retain.
selectRefundId If a refund was performed, unique id assigned by Vindicia Retain to the refund that was performed.
selectTransactionId Unique ID assigned by Vindicia Retain to the final Transaction attempt, which resulted in the status returned.
status Captured when the Transaction has been recovered by Vindicia Retain.  The authCode may still be a decline for force deposit.
subscriptionId The unique ID of the customer subscription.
timeStamp Time when the last failure of the transaction took place.  

Of the above result data returned by Vindicia Retain, the selectTransactionId was sent by Select to the payment processor in the Order Id/Number field when the Vindicia Retain transaction was processed. This means the Vindicia Retain transaction which was recovered / settled may be looked up in the Payment Processor using the selectTransactionId value as a search value for the Order ID in the payment processor portal.

2. In addition to the above, the following data from specific payment processors may be returned as well:


The Request ID corresponds to the Credit Card Settlement Status displayed in the Cybersource Business Center. The Request ID may be used to lookup the transaction in the Cybersource Business Center to locate a recovered Vindicia Retain Transaction.

The Request ID is returned on the Transaction in the name/value pair vin:PaymentProcessorTransactionId, as in the example below:

vin:PaymentProcessorTransactionId = 4471077305495000001519 (Request ID value)

By default, the selectTransactionId (assigned by Vindicia Retain to the final transaction attempt by Vindicia Retain) appears in the Merchant Reference Number field in the Cybersource Business Center. The Merchant Reference Number may be used to look up the Transaction in the Cybersource Business Center, by entering the selectTransactionId.

The merchant can request a configuration change for this behavior so that the unique identifier for the Failed transaction (as provided to Vindicia Retain in merchantTransactionIdappears in the Merchant Reference Number field. Please contact Vindicia to request this configuration change.

The selectTransactionId may be used to look up the Transaction by Merchant Reference Number in the Cybersource Business Center.  If the merchant requests a configuration change, the merchantTransactionId, (the merchant's unique identifier for the Failed Transaction), will appear in the Merchant Reference Number field instead. In this case, the merchantTransactionId  may be used to search by Merchant Reference Number rather than selectTransactionId.


The Capture Request ID is the value that was assigned by Litle/Vantiv to the Capture/Settlement request for the recovered Transaction. This value may be used to look up a recovered transaction in the Litle/Vantiv portal.

The Capture Request ID is returned on the transaction in the name/value pair vin:PaymentProcessorTransactionId, as in the example below:

vin:PaymentProcessorTransactionId = 83005839974481949 (Capture Request ID value)

For more information on working with data returned from Select, see the following sections in the Vindicia Select API guide: 

Sample Code

Not Applicable

Scenario Extensions



Certification Not Required

Use Case #: SEL-007

For Users

Learn More
For Users

Vindicia Subscribe Features

Learn More
Vindicia Subscribe Features
Back to Top