This API will allow you to perform all of the functions, tasks and queries that you require in your payment stack. With our API, you can choose which feature you would like to use and in what order to use it.
To get started, simply sign up to our service and set up your first API key . Thats it - you are ready to start using the API. It's that easy.
To make it even easier, our documentation pages include a fully functional API client which allows you to test our APIs directly and see for yourself how they work without writing a single line of code.
API Sections
We tried to arrange the API in logical way in to different sections. The API is made up of the following segments:
Payments Library
Payments Library | Payments Library Accounts |
---|---|
This set of methods allows you to interact with our Payments Library to facilitate all types of payment services. | This set of guides provides information on how to get merchant accounts necessary for the payment services you would like to use in the Payments Library.. |
Processing Cards
Payment Gateway Accounts | Universal Payment Gateway |
---|---|
This set of methods allows you to create, store and manage the credentials to the merchant accounts of your customers with the payment gateways. | This set of methods allows you to perform different charge requests to the payment gateway of choice. |
Tokenizing Cards
String Tokens |
---|
This set of methods allows you to store strings as tokens in our vault and edit and manage them within our secure storage. |
Utilities
Tools | Validating API |
---|---|
This set of methods allows you to perform different types of verification and validation of the credit card data provided. | The API offers a method to validate an ApiKey. This allows you to both verify that the ApiKey that you have is valid and also check that the Orchestra API is operational. |
Lastly, if there are any additional tasks that you need to perform in your payment stack and would like us to support them, please do not hesitate to contact us and provide us with details on what you are trying to achieve -> We would be happy to learn your needs and see if we can enhance our system to support them.
API Authentication
For most of the API methods, the authentication is done with your API key (which you create through our portal ). The API key should be submitted within the header parameter X-Api-Key
.
However, some methods, particularly in the CardOperations and ThreeDsSessions sections are based on a JWS bearer token which you will create through the API. The documentation of each method will indicate which authentication method should be used.
Context and Format
The base URL for all API requests is https://api.epaytools.com
. You would use the same URL whether you are using a production or sandbox account.
All request and response bodies are in JSON format. Required fields in the JSON are described as such in the documentation.