Skip to main content
Retain provides two distinct environments for testing and production:
  • Staging Environment: The Staging environment serves as your sandbox and allows you to test your application against the code currently running in Production without affecting your live data (https://api.staging.us-west.vindicia.coml)
  • Production Environment: The Production environment is for real-world use for actual billing and subscription activity (https://api.vindicia.com).
Note: The examples in this API reference use the Production URL. Replace with the Staging URL, when needed. Authentication to the API is performed via HTTP Basic Auth using your environment specific API user and key as the username and password. You receive your API credentials from your Vindicia Client Technical Support representative as part of the merchant onboarding process. Note: The Retain REST API credentials are not the same credentials used for Retain Portal access. We use built-in HTTP features, like HTTP authentication and HTTP verbs. All API requests must be made over HTTPS. Calls made over plain HTTP, and API requests made without authentication, will fail. cURL API Key Usage Example
Javascript API Key Usage Example

​
Test Access in Staging Environment

To test your staging (sandbox) environment, you can download the OpenAPI Yaml in this guide to a third-party app such as Postman, or curl. Using basic auth and your API credentials, make calls and receive responses. During your deployment, test your application’s payment processing in a simulated environment to ensure that your transactions behave as expected. For more information, see Test Data for Payment Providers. Parent topic:Retain REST API Access and Authentication