Merchants Endpoints

Endpoint	Link to Documentation
GET /v1/merchants/{mid}	Retrieve the details of a specific merchant.
GET /v1/merchants	Retrieve a list of onboarded merchants.

General Information

The Merchant Management API provides partners with the ability to retrieve detailed information about onboarded merchants. These APIs are RESTful and use standard HTTP methods (GET) to perform operations such as fetching individual merchant details or retrieving lists of onboarded merchants.

Some requests use URL parameters to specify the target merchant (mid), while others support optional query parameters for filtering and pagination.

Endpoints


Sandbox testing	https://api-sandbox.flex-charge.com/v1/
Production environment	https://api.flex-charge.com/v1/

The sandbox environment is a dedicated space for testing. Experiment freely without impacting production systems. When you are ready for live operations, production credentials will provide access to the operational environment.

❗️
Do not use real-world financial data in the Sandbox environment.

Headers

To interact with the Merchant Management API, include the following headers in your requests:

Name	Description	Request Type	Value
authorization	Every request must be authenticated.	GET	Bearer token
content-type	Specifies the media type of the resource.	N/A	application/json

Versioning

The Merchant Management API follows the versioning protocol outlined in the base API documentation.

For example, <https://api.flex-charge.com/v1/merchants/> indicates version 1 of the API.

Backward-incompatible changes will result in a version increment, while minor enhancements and fixes will not. Ensure your implementation can handle API updates, including additional, unspecified fields or varying response sizes.

Errors

The Merchant Management API uses standard HTTP response codes to communicate success or failure. Below is a list of common response codes and their meanings:

Response Code	Description
200 OK	The request completed successfully.
400 Bad Request	The request is malformed or missing required parameters.
401 Unauthorized	Authentication failed. Provide valid credentials to proceed.
403 Forbidden	Access to the resource is denied.
404 Not Found	The specified merchant could not be located.
405 Method Not Allowed	The HTTP method used is not allowed for this resource.
500 Internal Server Error	An unexpected error occurred on the server.
502 Bad Gateway	Received an invalid response from the upstream server.
503 Service Unavailable	The server is temporarily unable to process the request.
504 Gateway Timeout	The server timed out while attempting to process the request.