Introduction

The ZexPay.io API will provide businesses with access to our services and information. This page contains technical details and a guide to integrating API keys from each of our business tools. If you're not a website developer, this page may not be for you.

To begin the integration, all you need to do is create a "Faucet Owner" or "Merchant" profile (as needed) to obtain a unique API key. A unique API key is essential for providing primary identification when retrieving or creating information from our endpoint.

Calling Method

Our recommended method for calling each endpoint with your unique API key is using the cURL method (POST / GET).

It is important to remember that the API Key needs to be embedded in the HTTP Header with the api-key parameter.

You can create a main function by separating tags with arguments inside the function, it will make you easier to call our REST API endpoint without having to rewrite the cURL mechanism.

API Response

Every time you call our REST API endpoint, it will return a response in the form of an JSON object which always contains the key values: status, error, message, data.

• status: (Integer Value)
• error: (Boolean Value)
• message: (String Value)
• data: (Object or Null Value)

Example response:

JSONSuccess Response
{
  "status"  : 200,
  "error"   : false,
  "message" : "ok",
  "data"    : {...}
}

JSONError Response
{
  "status"  : 400,
  "error"   : true,
  "message" : "Bad Request",
  "data"    : null
}