System Status

This endpoint allows you to check the current status of the OxaPay API, ensuring it is functioning correctly.

GET https://api.oxapay.com/v1/common/monitor

200: OK

{
  "data": { 
      status: boolean // true for operational, false for offline/maintenance
   },
  "message": string, // A message containing additional information about the result of the request.
  "error": {
    "type": string,
    "key": string,
    "message": string
  } || {}, // An object that provides details about any errors that occurred.
  "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).
  "version": string // The version of the API being used.
}

Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding error for further details.

API Request Sample Codes

cURL

curl -X GET https://api.oxapay.com/v1/common/monitor

PHP

<?php

$url = 'https://api.oxapay.com/v1/common/monitor';

$options = array(
    'http' => array(
        'method' => 'GET'
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
if ($response === FALSE) {
    die('Error occurred');
}

$result = json_decode($response, true);
var_dump($result);
?>

Node.js

const axios = require('axios');

const url = 'https://api.oxapay.com/v1/common/monitor';

axios.get(url)
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests

url = 'https://api.oxapay.com/v1/common/monitor'

response = requests.get(url)
result = response.json()
print(result)

These example code snippets demonstrate how to request the "System Status" endpoint using different programming languages. You can customize the data parameters according to your specific requirements.

API Response Example

{
  "data": {
    "status": true
  },
  "message": "Operation completed successfully!",
  "error": {},
  "status": 200,
  "version": "1.0.0"
}

The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager.