API Basics
The API gives you access to all payment features that you can use on our dashboard and lets you extend them for use in your application. The API allows you initiate payment, make payment, and manage payout transactions between yourself and another party. Here's is what you need to do:
Create an account: Start your experience by creating a free Redstone account. By default, you would have access to your test environment after you sign up. The test keys can be generated from the developer's tab of the settings page.
Configure your integration: Utilize our API integration to configure your payment system.
Complete your KYC: To take your account live, We'll need to review your details and profile it correctly for the best experience. You are required to submit your business documents and other relevant information to make this review possible.
Go live and accept payments from your customers: Once your account has been approved, you can start collecting payments from your customers
When you've fully tested and are ready to go live, you can proceed to login then generate live API Keys to replace the test keys.
Making a Request
Next to each endpoint is the expected method to access that endpoint. All you need to do is pass in the specific parameters as will be shown in this documentation, and you can make calls to the endpoints.
Input/Output Format
Both request body data and response data are formatted as JSON. Content type for responses will always be application/json.
Generally, all responses will be in the following format:
Standard API response format
{
"status": [string] - indicating whether or not the request could be processed,
"code" : [integer] - indicating the request code,
"message": [string] - contains the result of the action that was processed,
"data": [object] - contains the payload of the action that was processed
}Base URL
All API requests must be made over HTTPS to the following base URL, and unencrypted HTTP connections are not supported.
Production
Ensure you send all requests to this right url. For example, when using the test API keys, make sure you send all requests to this url with the test key to prevent getting "Access denied" error. Similarly, when using the live keys, make sure you send all requests to the the url with the live keys.
Last updated