API Reference

Errors

Yangaplug attempts to handle all mistakes and errors as gracefully as possible.

We use industry standard HTTP codes to group errors and also use conventional HTTP response codes to indicate the success or failure of an API request.

👍

2XX Status code

Codes in this range confirms your request worked as expected (no errors)

🚧

4XX Status Code

Codes in this range indicates that the request failed due to the information in the request or situational reasons (e.g. an insufficient balance or a validation error on the request).

❗️

5XX Status Code

Codes in this range are extremely rare and indicates an error occurred on our system.

{
  "success": false,
  "message": "The recipient field is required.",
  "data": null
}

There are 3 fields that are returned in the response body

  • success: A boolean value to specify if your request was successful or not.
  • message: A graceful error message to give you a description of what is going on
  • data: The actual data for the response body