Welcome to the Ansa API Reference
This guide covers basic Ansa API concepts and documents the usage of each of the API endpoints.
Getting Started
To begin testing and integrating with the Ansa API, please reach out to us at [email protected]. We will set up a Sandbox merchant for you and assist you in the integration process while answering any questions you may have. This Sandbox merchant will connect with your current payment service provider, but no real cards or funds will be transacted.
Conventions
The base URL to send all API requests is https://api.getansa.com. HTTPS is required for all API requests.
The Ansa API follows RESTful conventions when possible, with most operations performed via GET, POST, PUT, and DELETE requests. Request and response bodies are encoded as JSON.
Temporal values (datetimes) are encoded in RFC 3339 format. i.e 2022-09-16T19:28:23.120Z
Versioning
The Ansa API is versioned. Currently, the Ansa API has a single version v1 that is available to all merchants on the platform. Versioning is included as the first path in the URL, such as https://api.getansa.com/v1.
A new API version will be released when we introduce a backwards-incompatible change to the API.