Basics

Overview

The Base URL serves as the entry point for accessing the features and functionalities offered by Eazipay. Whether you're retrieving data, updating information, or performing any other operation, all API requests should originate from this URL.
The Base URL for the API is:

Text

https://api.myeazipay.com/api/v1

All API requests, regardless of the specific endpoint or functionality, should be directed to this Base URL. When constructing your HTTP requests, prepend the desired endpoint path to the Base URL.

Response Format

All responses from the API are formatted in JSON. The JSON format provides a structured and standardized way to convey data, facilitating easy parsing and interpretation for your applications.

JSON

{
  "success": "boolean",
  "message: "string",
  "data": "object"
}

"status": boolean indicates that the request was successful as true and failed as false.

"message": string gives the information about the request you made and the status.

"data": object contains the actual payload of the response. It can either be an object or an array

Error Responses

In the event of an error, the API will return an error response. The response will include a status of false indicating failure and a message with details about the error.

JSON

{
    "success": "boolean",
    "message": "string"
}

Here is an example of an error response:

JSON

{
    "success": false,
    "message": "Authentication failed"
}

Eazipay provides informative error messages to help you diagnose and troubleshoot issues that may arise during your interactions with the API.

HTTP Status Codes

The API uses standard HTTP status codes to indicate the outcome of a request. Here are some common status codes you may encounter:

200 OK: The request was successful.
201 Created: The request resulted in the creation of a new resource.
400 Bad Request: The request was malformed or invalid.
401 Unauthorized: The provided API key is not valid.
403 Forbidden: The request is understood, but it has been refused or access is not allowed.
404 Not Found: The requested resource could not be found.
429 Too Many Requests: Client has made too many requests in a given amount of time.
500 Internal Server Error: An unexpected condition was encountered.