The Return Object

All methods in the Vindicia Retain API return a Return object, which contains the return codes for the call.

The Return object contains three data members:

• returnCode: This data member contains a value that corresponds to a standard HTTP return code. For values of 400 or higher, assume that your call failed. The failure could be due to several reasons, such as an authentication failure or a Vindicia Subscribe failure to find any objects that match your input. See Select Return Codes for a list of the most common return codes.
• returnString: If returnCode indicates an error condition (a non-200 return code), your application can check returnString for further information. Use the Vindicia Retain API to generate a log of returnString, to help you debug your application in the development and production phases.
  
  (The returnString is not saved in the Vindicia Retain database, and has no size limit; however, the meaningful data is usually located within the first 512 bytes.)
• soapId: This ID is returned for certain calls to Vindicia, especially those made to submit a batch of data (for example, a batch of transactions or chargebacks) for ChargeGuard processing. This ID helps Vindicia track your batched data in Vindicia’s system and, if the ID is available, you should log it in your application. If an incident arises that requires troubleshooting by Vindicia, a Vindicia representative might ask you for this ID to determine the status of your data.
  
  (The soapID is a 40-byte string.)

Some return strings contain information specific to the call for which the return was generated. In some cases, these will take the format:

Unable to load Transaction by merchantId input-ID: No match

where input-ID specifies the object or call to which the return error applies.

In some cases, these will take the format:

Unable to load Transaction by merchantId input-ID: error-description

where error-description more specifically explains the cause of the error. In both cases, variable text is displayed in bold-italic.

The following table lists and describes the most common return codes. If a method returns different return codes, they are listed with the method.

Return Code	Description
200	The call succeeded.
400	Your call failed, which could be due to an authentication failure or a Vindicia Subscribe failure to find any objects that match your input. 400 may also be one of the following: Billing has already been attempted for Transaction ID merchantTransactionId. Failed to deserialize Transaction. Invalid Arguments - No transaction object.
403	The Vindicia server cannot authenticate your request.
404	One of the following: Unable to load transaction: no match for merchantTransactionId merchantTransactionId. Unable to load transaction: no match for VID vid.
405	Unable to save transaction.
500	The Vindicia server encountered an internal error. That error could occur for various reasons, the most common being an incorrectly populated input object, especially when you are making the call from a client library whose language does not support strict data-type checking. For resolution, especially during the development phase, contact Vindicia Technical Support.
503	A Vindicia back-end service, such as a database, is unavailable. Retry your call later.