OxaPay Docs
v1
v1
  • Introduction
    • Welcome to OxaPay
    • Integrations
      • Payment Link
      • Donation Service
      • Merchant Service
      • Payout Service
      • Swap Service
      • Plugins
        • WooCommerce
        • WISECP
        • Clientexec
        • Blesta
        • WHMCS
        • PrestaShop
        • Easy Digital Downloads
        • Paid Memberships Pro
        • Gravity Forms
        • Restrict Content Pro
  • API Reference
    • Payment
      • Generate Invoice
      • Generate White Label
      • Generate Static Address
      • Revoking Static Address
      • Static Address List
      • Payment Information
      • Payment History
      • Accepted Currencies
      • Payment Status Table
    • Payout
      • Generate Payout
      • Payout Information
      • Payout History
      • Payout Status Table
    • Swap
      • Swap Request
      • Swap History
      • Swap Pairs
      • Swap Calculate
      • Swap Rate
    • Common
      • Account Balance
      • Prices
      • Supported Currencies
      • Supported Fiat Currencies
      • Supported Networks
      • System Status
    • Error
  • Webhook
  • Use Cases
Powered by GitBook
On this page
  1. API Reference

Error

API Error Responses

When an error occurs in the OxaPay API, the response will be structured in a standardized format. This allows users to easily identify and address issues with their requests. Below is an overview of the error response structure, the possible status codes, and the types of errors you may encounter.

{
  "data": {},
  "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.
}

Statuses

Status Code

Meaning

Common Causes

200 OK

The request was successful.

The request was processed without errors.

400 Bad Request

The request was invalid or malformed.

Missing required fields, invalid data format, or unacceptable parameter values.

401 Unauthorized

The user is not authenticated or has invalid credentials.

Missing or invalid API key, incorrect session or token.

404 Not Found

The requested resource could not be found.

The resource doesn't exist or the endpoint is incorrect.

500 Internal Server Error

An unexpected server-side error occurred.

Server failure, issues with third-party integrations or dependencies.

503 Service Unavailable

One of the services is temporarily unavailable.

Server overload, service downtime, or maintenance.

PreviousSystem StatusNextWebhook

Last updated 3 months ago