OxaPay

https://docs.oxapay.com
Admin
OxaPay is a leading crypto payment gateway that provides a robust and secure platform for businesses...
Tokens:30,667
Snippets:136
Trust Score:9.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Query documentation via HTTP GET

Source: https://docs.oxapay.com/llms.txt

Perform an HTTP GET request to the documentation index with an ask parameter to receive a direct answer and relevant excerpts.

```http
GET https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### GET /general/swap

Source: https://docs.oxapay.com/api-reference/swap/swap-history.md

Retrieves a list of swap exchanges based on provided filter criteria.

```APIDOC
## GET /general/swap

### Description
Retrieves a list of swap exchanges based on provided filter criteria.

### Method
GET

### Endpoint
/general/swap

### Parameters
#### Header Parameters
- **general_api_key** (string) - Required - Your General API Key for authentication and authorization.
- **Content-Type** (string) - Required - Default: application/json

#### Query Parameters
- **track_id** (integer) - Optional - Filter specific exchange by its trackId.
- **type** (string) - Optional - Filter exchanges based on type (autoConvert, manualSwap, swapByApi).
- **from_currency** (string) - Optional - Specify the currency symbol for filtering exchanges in a specific fromCurrency.
- **to_currency** (string) - Optional - Specify the currency symbol for filtering exchanges in a specific toCurrency.
- **from_date** (integer) - Optional - The start of the date window to query for exchanges in unix format.
- **to_date** (integer) - Optional - The start of the date window to query for exchanges in unix format.
- **sort_by** (string) - Optional - Sort the received list by a parameter (create_date, amount). Default: create_date.
- **sort_type** (string) - Optional - Display the list in ascending or descending order (asc, desc). Default: desc.
- **size** (integer) - Optional - Number of records to be displayed on one page (1-200). Default: 10.
- **page** (integer) - Optional - The page number of the results you want to retrieve. Default: 1.
```

--------------------------------

### GET /payment

Source: https://docs.oxapay.com/api-reference/payment/payment-history.md

Retrieves a list of payments to track their status and generate reports.

```APIDOC
## GET /payment

### Description
It is used to track the payment status and generate reports.

### Method
GET

### Endpoint
/payment

### Response
#### Success Response (200)
- **type** (string) - Describes the payment type, e.g., invoice, white-label, etc.
- **amount** (number) - The total amount of the invoice in the specified currency.
- **currency** (string) - The currency of the payment, e.g., USD, EUR, BTC.
- **status** (string) - The current status of the invoice, such as pending, completed, failed, etc.
- **mixed_payment** (boolean) - A flag indicating whether the payment is mixed.
- **callback_url** (string) - The URL to which payment status updates will be sent.
- **description** (string) - A description for the invoice.
- **email** (string) - The email address of the payer.
- **fee_paid_by_payer** (number) - Indicates if the payer is responsible for paying the network fees.
- **lifetime** (integer) - The lifetime of the invoice in minutes before it expires.
- **order_id** (string) - A unique identifier for the order associated with this invoice.
- **under_paid_coverage** (number) - The percentage of underpayment that will still be considered valid.
- **return_url** (string) - The URL the user will be redirected to after completing the payment.
- **thanks_message** (string) - A custom message to thank the user for the payment.
- **expired_at** (integer) - Timestamp (UNIX epoch) when the invoice will expire.
- **date** (integer) - Timestamp (UNIX epoch) of when the invoice was created.
- **txs** (array) - List of transactions associated with the payment.
```

--------------------------------

### GET /common/monitor

Source: https://docs.oxapay.com/api-reference/common/system-status.md

Retrieves the current operational status of the OxaPay API.

```APIDOC
## GET /common/monitor

### Description
Get API monitor status to ensure the OxaPay API is functioning correctly.

### Method
GET

### Endpoint
/common/monitor

### Response
#### Success Response (200)
- **data** (object) - Contains the status field.
- **data.status** (boolean) - Indicates whether the OxaPay API monitor status is operational.
- **message** (string) - A message containing additional information about the result of the request.
- **error** (object) - An object that provides details about any errors that occurred.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### GET /welcome-to-oxapay/integrations/plugins/blesta.md

Source: https://docs.oxapay.com/llms.txt

Performs a natural language query against the documentation index to retrieve answers and relevant excerpts.

```APIDOC
## GET /welcome-to-oxapay/integrations/plugins/blesta.md

### Description
Perform an HTTP GET request on the documentation index with the `ask` parameter, and the optional `goal` parameter to retrieve a direct answer and relevant documentation excerpts.

### Method
GET

### Endpoint
https://docs.oxapay.com/welcome-to-oxapay/integrations/plugins/blesta.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /general/swap

Source: https://docs.oxapay.com/api-reference/swap/swap-history.md

Retrieve a list of swap transactions based on your General API Key, with support for filtering and pagination.

```APIDOC
## GET /general/swap

### Description
Retrieve a list of swap transactions based on your General API Key. Results can be filtered by criteria such as time range, currency, and swap type, and are returned with pagination support.

### Method
GET

### Endpoint
/general/swap

### Response
#### Success Response (200)
- **data** (object) - Contains the list of transactions and pagination metadata.
  - **list** (array) - Array of swap transactions.
    - **track_id** (string) - Unique identifier for the transaction.
    - **from_currency** (string) - The currency being exchanged from.
    - **to_currency** (string) - The currency being exchanged to.
    - **from_amount** (number) - The amount of the from_currency swapped.
    - **to_amount** (number) - The amount of the to_currency received.
    - **rate** (number) - The exchange rate at the time of the transaction.
    - **date** (integer) - UNIX epoch timestamp of the swap.
  - **meta** (object) - Pagination details.
    - **page** (integer) - Current page number.
    - **last_page** (integer) - Total number of pages.
    - **total** (integer) - Total number of records.
- **message** (string) - Additional information about the result.
- **status** (integer) - Numeric status code.
- **version** (string) - API version.
```

--------------------------------

### GET /general/account/balance

Source: https://docs.oxapay.com/api-reference/common/account-balance.md

Retrieves the details of all wallets associated with a user, including a list of currencies and their corresponding amounts.

```APIDOC
## GET /general/account/balance

### Description
Retrieves the details of all wallets associated with a user, including a list of currencies and their corresponding amounts. If a currency is specified, it returns the balance for that specific currency only.

### Method
GET

### Endpoint
/general/account/balance

### Parameters
#### Header Parameters
- **general_api_key** (string) - Required - Your General API Key for authentication and authorization.
- **Content-Type** (string) - Required - Defaults to application/json.

#### Query Parameters
- **currency** (string) - Optional - Specify a specific currency to get the balance for that currency. If not provided, the response will contain the balance for all available currencies.

### Response
#### Success Response (200)
- **data** (object) - Object keyed by currency symbol. Each value represents the account balance for that currency.
- **message** (string) - A message containing additional information about the result of the request.
- **error** (object) - An object that provides details about any errors that occurred.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### Webhook Callback Handling

Source: https://docs.oxapay.com/webhook.md

This section provides implementation examples for receiving and verifying webhook callbacks. The system sends a POST request to your configured endpoint, which must be validated using an HMAC signature generated with your API secret key.

```APIDOC
## POST /callback

### Description
Receives and processes webhook notifications. The request body contains the event data, and the request header 'HMAC' contains the signature for verification.

### Method
POST

### Endpoint
/callback

### Request Headers
- **HMAC** (string) - Required - The HMAC-SHA512 signature of the request body.

### Request Body
- **type** (string) - Required - The type of event (e.g., 'invoice', 'payout').

### Response
#### Success Response (200)
- **OK** (string) - Indicates successful receipt and processing.

#### Error Response (400)
- **Invalid HMAC signature** (string) - Returned when the signature verification fails.
- **Invalid data.type** (string) - Returned when the event type is unrecognized.
```

--------------------------------

### GET /payment

Source: https://docs.oxapay.com/api-reference/payment/payment-history.md

Retrieves a list of payments associated with the account, supporting filtering and pagination.

```APIDOC
## GET /payment

### Description
Use this endpoint to retrieve a list of payments associated with your account, determined by your Merchant API Key. You can filter the results using various criteria, including time range, payment status, amount, payment type, and more. Additionally, the endpoint supports pagination with page and size parameters.

### Method
GET

### Endpoint
/payment

### Response
#### Success Response (200)
- **data** (object) - The container for the payment list.
- **list** (array) - A list of payment objects.
- **track_id** (string) - Unique identifier for each payment session in the OxaPay payment gateway.
```

--------------------------------

### GET /general/swap/pairs

Source: https://docs.oxapay.com/api-reference/swap/swap-pairs.md

Retrieves a list of all available cryptocurrency swap pairs along with their respective minimum swap amounts.

```APIDOC
## GET /general/swap/pairs

### Description
Retrieves a list of all available cryptocurrency swap pairs along with their respective minimum swap amounts. This helps users identify valid currency pairs and the minimum threshold required for a swap.

### Method
GET

### Endpoint
/general/swap/pairs

### Parameters
#### Header Parameters
- **general_api_key** (string) - Required - Your General API Key for authentication and authorization.
- **Content-Type** (string) - Required - Defaults to application/json.

### Response
#### Success Response (200)
- **data** (object) - Contains the list of swap pairs.
- **data.list** (array) - List of available pairs.
- **data.list.from_currency** (string) - The currency being exchanged from.
- **data.list.to_currency** (string) - The currency being exchanged to.
- **data.list.min_amount** (number) - The minimum amount of the from_currency required.
- **message** (string) - Additional information about the result.
- **status** (integer) - The status code of the response.
- **version** (string) - The API version.
```

--------------------------------

### GET /payment

Source: https://docs.oxapay.com/api-reference/payment/payment-history.md

Retrieves a list of payments based on specified filter criteria.

```APIDOC
## GET /payment

### Description
Retrieves a list of payments based on specified filter criteria.

### Method
GET

### Endpoint
/payment

### Parameters
#### Header Parameters
- **merchant_api_key** (string) - Required - Your Merchant API Key for authentication and authorization.
- **Content-Type** (string) - Required - Default: application/json

#### Query Parameters
- **track_id** (integer) - Optional - Filter payments by a specific invoice ID.
- **type** (string) - Optional - Filter payments by type (invoice, white_label, static_address).
- **status** (string) - Optional - Filter payments by status (Paying, Paid).
- **pay_currency** (string) - Optional - Filter payments by a specific crypto currency symbol.
- **currency** (string) - Optional - Filter payments by a specific currency symbol.
- **network** (string) - Optional - Filter payments by the expected blockchain network.
- **address** (string) - Optional - Filter payments by the expected address.
- **from_date** (integer) - Optional - The start of the date window to query for payments in UNIX format.
- **to_date** (integer) - Optional - The end of the date window to query for payments in UNIX format.
- **from_amount** (number) - Optional - Filter payments with amounts greater than or equal to the specified value.
- **to_amount** (number) - Optional - Filter payments with amounts less than or equal to the specified value.
- **sort_by** (string) - Optional - Sort the received list by a parameter (create_date, pay_date, amount). Default: create_date.
- **sort_type** (string) - Optional - Display the list in ascending or descending order (asc, desc). Default: desc.
- **page** (integer) - Optional - The page number of the results. Default: 1.
- **size** (integer) - Optional - Number of records to display per page (1-200). Default: 10.
```

--------------------------------

### GET /common/fiats

Source: https://docs.oxapay.com/api-reference/common/supported-fiat-currencies.md

Retrieves a list of all supported fiat currencies with their associated metadata and pricing information.

```APIDOC
## GET /common/fiats

### Description
Retrieves a list of supported fiat currencies, including currency code, symbol, name, price, and display precision. This data is useful for merchants creating invoices in specific fiat currencies.

### Method
GET

### Endpoint
https://api.oxapay.com/v1/common/fiats

### Response
#### Success Response (200)
- **data** (object) - Object keyed by fiat currency symbol. Each item includes:
  - **symbol** (string) - The symbol of the currency.
  - **name** (string) - The name of the currency.
  - **price** (number) - The current price of the currency.
  - **display_precision** (number) - Decimal precision used when displaying the currency.
- **message** (string) - A message containing additional information about the result.
- **error** (object) - Details about any errors that occurred (nullable).
- **status** (integer) - The status code of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### GET /payment/static-address

Source: https://docs.oxapay.com/api-reference/payment/static-address-list.md

Retrieves a list of static addresses based on optional filter criteria.

```APIDOC
## GET /payment/static-address

### Description
Retrieves a list of static payment addresses. Supports filtering by transaction history, order ID, email, and pagination.

### Method
GET

### Endpoint
/payment/static-address

### Parameters
#### Query Parameters
- **have_tx** (boolean) - Optional - Filter the addresses that had transactions.
- **order_id** (string) - Optional - Filter addresses by a unique order ID for reference.
- **email** (string) - Optional - Filter addresses by the email.
- **page** (integer) - Optional - The page number of the results you want to retrieve (default: 1).
- **size** (integer) - Optional - Number of records to display per page (max: 200, default: 1).
```

--------------------------------

### GET /common/currencies

Source: https://docs.oxapay.com/api-reference/common/supported-currencies.md

Retrieves a comprehensive list of supported cryptocurrencies, including their network details, symbols, names, and withdrawal information.

```APIDOC
## GET /common/currencies

### Description
Get supported cryptocurrencies and their associated network configurations.

### Method
GET

### Endpoint
https://api.oxapay.com/v1/common/currencies

### Response
#### Success Response (200)
- **data** (object) - Object keyed by cryptocurrency symbol. Each item includes currency metadata and supported networks.
- **message** (string) - A message containing additional information about the result of the request.
- **error** (object) - An object that provides details about any errors that occurred.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### OpenAPI Specification for GET /payment/stats

Source: https://docs.oxapay.com/api-reference/payment/payment-statistics.md

The full OpenAPI schema definition for the payment statistics endpoint, including request parameters and response structures.

```json
{"openapi":"3.0.0","info":{"title":"Payments","version":"1.0.0"},"servers":[{"url":"https://api.oxapay.com/v1"}],"security":[],"paths":{"/payment/stats":{"get":{"operationId":"getPaymentStatistics","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"list":{"type":"array","description":"A list of aggregated payment statistics grouped by cryptocurrency.","items":{"type":"object","properties":{"pay_currency":{"type":"string","description":"The cryptocurrency symbol in which the payment was received."},"total":{"type":"integer","description":"The total number of payments for this cryptocurrency."},"received_amount":{"type":"string","description":"The total received amount for this cryptocurrency. Returned as a decimal string to preserve precision."}}}},"meta":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number of the result set."},"last_page":{"type":"integer","description":"The total number of pages available based on the number of records and page size."},"total":{"type":"integer","description":"The total number of statistic records available for the specified criteria."}}}}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error."},"key":{"type":"string","description":"Key related to the error."},"message":{"type":"string","description":"Error message."}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code."},"version":{"type":"string","description":"The version of the API being used."}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors)."},"version":{"type":"string","description":"The version of the API being used."}}}}}}},"tags":["payment-statistics"],"parameters":[{"in":"header","name":"merchant_api_key","required":true,"schema":{"type":"string"},"description":"Your Merchant API Key for authentication and authorization."},{"in":"header","name":"Content-Type","required":true,"schema":{"type":"string","default":"application/json"}},{"name":"type","in":"query","description":"Filter payment statistics by payment type.","required":false,"schema":{"type":"string","enum":["invoice","white_label","static_address"]}},{"name":"network","in":"query","description":"Filter payment statistics by blockchain network.","required":false,"schema":{"type":"string"}},{"name":"pay_currency","in":"query","description":"Filter payment statistics by a specific cryptocurrency symbol.","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"The start of the date window to query for payment statistics in UNIX timestamp format.","required":false,"schema":{"type":"integer"}},{"name":"to_date","in":"query","description":"The end of the date window to query for payment statistics in UNIX timestamp format.","required":false,"schema":{"type":"integer"}}]}}}}
```

--------------------------------

### Get API monitor status OpenAPI definition

Source: https://docs.oxapay.com/api-reference/common/system-status.md

Defines the GET /common/monitor endpoint structure and response schema.

```json
{"openapi":"3.0.0","info":{"title":"Commons","version":"1.0.0"},"servers":[{"url":"https://api.oxapay.com/v1"}],"security":[],"paths":{"/common/monitor":{"get":{"operationId":"monitor","summary":"Get API monitor status","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"boolean","description":"Indicates whether the OxaPay API monitor status is operational."}}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code."},"version":{"type":"string","description":"The version of the API being used."}}}}}}},"tags":["Monitor"]}}}}
```

--------------------------------

### Webhook Notification Handling

Source: https://docs.oxapay.com/webhook.md

Guidelines for implementing a webhook listener to receive payment and payout status updates.

```APIDOC
## Webhook Notification

### Description
OxaPay sends automated HTTP POST notifications to your specified `callback_url` when a payment or payout status changes. The system expects an HTTP 200 response with the body "ok" to confirm successful delivery.

### Method
POST

### Request Body
- **status** (string) - The current status of the transaction (e.g., "paying", "paid").
- **amount** (number) - The transaction amount.
- **address** (string) - The relevant address for the transaction or withdrawal.

### Response
#### Success Response (200)
- **body** (string) - Must return "ok" to acknowledge receipt.

### Retry Policy
If the endpoint does not return 200 OK, the system will retry up to 5 times with increasing delays: 1 minute, 3 minutes, 30 minutes, and 3 hours.
```

--------------------------------

### GET /common/networks

Source: https://docs.oxapay.com/api-reference/common/supported-networks.md

Retrieves a list of all blockchain networks supported by OxaPay.

```APIDOC
## GET /common/networks

### Description
Retrieves a list of blockchain networks supported by OxaPay for cryptocurrency transactions.

### Method
GET

### Endpoint
/common/networks

### Response
#### Success Response (200)
- **data** (object) - Contains the list of networks.
- **data.list** (array) - List of supported blockchain networks.
- **message** (string) - A message containing additional information about the result of the request.
- **error** (object) - An object that provides details about any errors that occurred.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### Webhook Callback Handling

Source: https://docs.oxapay.com/webhook.md

Implementations for receiving, parsing, and verifying HMAC signatures for webhook callbacks.

```php
<?php
// Get the request data
$postData = file_get_contents('php://input');
$data = json_decode($postData, true);

// Validate HMAC signature
if ($data['type'] === 'invoice') {
    $apiSecretKey = 'YOUR_MERCHANT_API_KEY';
} elseif ($data['type'] === 'payout') {
    $apiSecretKey = 'YOUR_PAYOUT_API_KEY';
} else {
    http_response_code(400);
    echo 'Invalid data.type';
    exit;
}

$hmacHeader = $_SERVER['HTTP_HMAC'];
$calculatedHmac = hash_hmac('sha512', $postData, $apiSecretKey);

if ($calculatedHmac === $hmacHeader) {
    // HMAC signature is valid
    // Process the callback data
    if ($data['type'] === 'payment') {
        echo 'Received payment callback: ' . json_encode($data);
        // Process payment data here
    } elseif ($data['type'] === 'payout') {
        echo 'Received payout callback: ' . json_encode($data);
        // Process payout data here
    }

    // Return HTTP Response 200 with content "OK"
    http_response_code(200);
    echo 'OK';
} else {
    // HMAC signature is not valid
    // Handle the error accordingly
    http_response_code(400);
    echo 'Invalid HMAC signature';
}
?>
```

```javascript
const http = require('http');
const crypto = require('crypto');

const server = http.createServer((req, res) => {
    if (req.url === '/callback' && req.method === 'POST') {
        // Validate HMAC signature
        let postData = '';

        req.on('data', chunk => {
            postData += chunk;
        });

        req.on('end', () => {
            // Parse the JSON data
            let data = null;
            try {
                data = JSON.parse(postData);
            } catch (error) {
                res.statusCode = 400;
                res.end('Invalid JSON data');
                return;
            }

            const apiSecretKey = (data.type === 'payment') ? 'YOUR_MERCHANT_API_KEY' : 'YOUR_PAYOUT_API_KEY';
            const hmacHeader = req.headers['hmac'];
            const calculatedHmac = crypto
                .createHmac('sha512', apiSecretKey)
                .update(postData)
                .digest('hex');

            if (calculatedHmac === hmacHeader) {
                // HMAC signature is valid
                // Process the callback data based on the type
                if (data.type === 'invoice') {
                    console.log('Received payment callback:', data);
                    // Process payment data here
                } else if (data.type === 'payout') {
                    console.log('Received payout callback:', data);
                    // Process payout data here
                }

                // Return HTTP Response 200 with content "OK"
                res.statusCode = 200;
                res.end('OK');
            } else {
                // HMAC signature is not valid
                // Handle the error accordingly
                res.statusCode = 400;
                res.end('Invalid HMAC signature');
            }
        });
    } else {
        // Invalid path or method
        res.statusCode = 404;
        res.end('Not Found');
    }
});

server.listen(3000, () => {
    console.log('Server listening on port 3000');
});
```

```python
from flask import Flask, request
import hmac
import hashlib
import json

app = Flask(__name__)

@app.route('/callback', methods=['POST'])
def handle_callback():
    post_data = request.get_data(as_text=True)
    data = json.loads(post_data)

    # Validate HMAC signature
    if data['type'] == 'payment':
        api_secret_key = 'YOUR_MERCHANT_API_KEY'
    elif data['type'] == 'payout':
        api_secret_key = 'YOUR_PAYOUT_API_KEY'
    else:
        return 'Invalid data.type', 400
    hmac_header = request.headers.get('HMAC')
    post_data = request.get_data()
    calculated_hmac = hmac.new(api_secret_key.encode(), post_data, hashlib.sha512).hexdigest()

    if calculated_hmac == hmac_header:
        # HMAC signature is valid
        # Process the callback data
        if data['type'] == 'invoice':
            print('Received payment callback:', data)
            # Process payment data here
        elif data['type'] == 'payout':
            print('Received payout callback:', data)
            # Process payout data here
            # Return HTTP Response 200 with content "OK"
        return 'OK', 200
    else:
        # HMAC signature is not valid
        # Handle the error accordingly
        return 'Invalid HMAC signature', 400


if __name__ == '__main__':
    app.run(host='YOUR_HOST_ADDRESS',port=3000)
```

--------------------------------

### GET /common/prices

Source: https://docs.oxapay.com/api-reference/common/prices.md

Retrieves the current prices of all cryptocurrencies supported by OxaPay.

```APIDOC
## GET /common/prices

### Description
Get the current prices of all cryptocurrencies supported by OxaPay.

### Method
GET

### Endpoint
/common/prices

### Response
#### Success Response (200)
- **data** (object) - Object keyed by cryptocurrency symbol. Each value represents the current price.
- **message** (string) - A message containing additional information about the result of the request.
- **error** (object) - An object that provides details about any errors that occurred.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### POST /general/swap/rate

Source: https://docs.oxapay.com/api-reference/swap/swap-rate.md

Fetches the real-time swap rate between two specified cryptocurrency pairs.

```APIDOC
## POST /general/swap/rate

### Description
Fetches the real-time swap rate between two specified cryptocurrency pairs.

### Method
POST

### Endpoint
/general/swap/rate

### Parameters
#### Header Parameters
- **general_api_key** (string) - Required - Your General API Key for authentication and authorization.
- **Content-Type** (string) - Required - Must be application/json.

#### Request Body
- **from_currency** (string) - Required - Specify the currency symbol you want to swap from.
- **to_currency** (string) - Required - Specify the currency symbol you want to swap to.

### Request Example
{
  "from_currency": "BTC",
  "to_currency": "USDT"
}

### Response
#### Success Response (200)
- **data** (object) - Contains the swap rate information.
  - **rate** (decimal) - The swap rate between the "from_currency" and "to_currency" at the time of the request.
- **message** (string) - A message containing additional information about the result of the request.
- **error** (object) - An object that provides details about any errors that occurred.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.

#### Response Example
{
  "data": {
    "rate": 65000.00
  },
  "message": "Success",
  "error": null,
  "status": 200,
  "version": "1.0.0"
}
```

--------------------------------

### GET /payment/stats

Source: https://docs.oxapay.com/api-reference/payment/payment-statistics.md

Retrieve aggregated payment statistics associated with your account, grouped by cryptocurrency.

```APIDOC
## GET /payment/stats

### Description
Retrieve aggregated payment statistics associated with your account, determined by your Merchant API Key. The results are grouped by cryptocurrency and include the total number of payments and the total received amount for each pay currency.

### Method
GET

### Endpoint
/payment/stats

### Parameters
#### Header Parameters
- **merchant_api_key** (string) - Required - Your Merchant API Key for authentication and authorization.
- **Content-Type** (string) - Required - Defaults to application/json.

#### Query Parameters
- **type** (string) - Optional - Filter payment statistics by payment type (invoice, white_label, static_address).
- **network** (string) - Optional - Filter payment statistics by blockchain network.
- **pay_currency** (string) - Optional - Filter payment statistics by a specific cryptocurrency symbol.
- **from_date** (integer) - Optional - The start of the date window to query for payment statistics in UNIX timestamp format.
- **to_date** (integer) - Optional - The end of the date window to query for payment statistics in UNIX timestamp format.

### Response
#### Success Response (200)
- **data** (object) - Contains the list of statistics and meta information.
- **data.list** (array) - A list of aggregated payment statistics grouped by cryptocurrency.
- **data.meta** (object) - Pagination information.
- **message** (string) - A message containing additional information about the result of the request.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### GET /payout

Source: https://docs.oxapay.com/api-reference/payout/payout-history.md

Retrieves a paginated list of payouts based on specified filter criteria.

```APIDOC
## GET /payout

### Description
Retrieve a list of payout records. This endpoint supports filtering by status, type, currency, network, amount, and date, as well as pagination and sorting.

### Method
GET

### Endpoint
/payout

### Parameters
#### Header Parameters
- **payout_api_key** (string) - Required - Your Payout API Key for authentication and authorization.
- **Content-Type** (string) - Required - Default: application/json

#### Query Parameters
- **status** (string) - Optional - Filter payouts based on their status (processing, complete, rejected, etc.).
- **type** (string) - Optional - Filter payouts based on type (external, internal).
- **currency** (string) - Optional - Specify the currency symbol for filtering payouts in a specific currency.
- **network** (string) - Optional - Specify the blockchain network for filtering payouts on a particular network.
- **from_amount** (number) - Optional - Specify the minimum payout amount for filtering.
- **to_amount** (number) - Optional - Specify the maximum payout amount for filtering.
- **from_date** (integer) - Optional - The start of the date window to query for payouts in UNIX format.
- **to_date** (integer) - Optional - The end of the date window to query for payouts in UNIX format.
- **sort_by** (string) - Optional - Sort the received list by a parameter (create_date, pay_date, amount). Default: create_date.
- **sort_type** (string) - Optional - Display the list in ascending or descending order (asc, desc). Default: desc.
- **size** (integer) - Optional - Number of records to be displayed on one page (1-200). Default: 10.
- **page** (integer) - Optional - The page number of the results you want to retrieve. Default: 1.
```

--------------------------------

### POST /general/swap

Source: https://docs.oxapay.com/api-reference/swap/swap-request.md

Swaps one cryptocurrency for another instantly at the current market rate.

```APIDOC
## POST /general/swap

### Description
This endpoint allows you to swap your account assets. You can swap one cryptocurrency for another instantly at the current market rate.

### Method
POST

### Endpoint
/general/swap

### Parameters
#### Header Parameters
- **general_api_key** (string) - Required - Your General API Key for authentication and authorization.
- **Content-Type** (string) - Required - Default: application/json

#### Request Body
- **from_currency** (string) - Required - Specify the currency symbol you want to swap from.
- **to_currency** (string) - Required - Specify the currency symbol you want to swap to.
- **amount** (number) - Required - Specify the amount of currency you want to swap.

### Response
#### Success Response (200)
- **data** (object) - Transaction details including track_id, from_currency, to_currency, from_amount, to_amount, rate, and date.
- **message** (string) - A message containing additional information about the result of the request.
- **error** (object) - An object that provides details about any errors that occurred.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### OpenAPI Specification for Swap Calculate

Source: https://docs.oxapay.com/api-reference/swap/swap-calculate.md

The OpenAPI definition for the /general/swap/calculate endpoint, detailing request parameters and response structures.

```json
{"openapi":"3.0.0","info":{"title":"Swaps","version":"1.0.0"},"servers":[{"url":"https://api.oxapay.com/v1"}],"security":[],"paths":{"/general/swap/calculate":{"post":{"operationId":"swapCalculate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from_currency","to_currency","amount"],"properties":{"from_currency":{"type":"string","description":"Specify the currency symbol you want to swap from."},"to_currency":{"type":"string","description":"Specify the currency symbol you want to swap to."},"amount":{"type":"number","format":"decimal","description":"Specify the amount of currency you want to swap."}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"to_amount":{"type":"number","format":"decimal","description":"The amount of the \"to_currency\" received after the swap, represented with high precision."},"rate":{"type":"number","format":"decimal","description":"The swap rate between the \"from_currency\" and \"to_currency\" at the time of the request."},"amount":{"type":"number","format":"decimal","description":"The amount of the \"from_currency\" being swapped, represented with high precision."}}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors)."},"version":{"type":"string","description":"The version of the API being used."}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors)."},"version":{"type":"string","description":"The version of the API being used."}}}}}}},"tags":["Swap-calculate"],"parameters":[{"in":"header","name":"general_api_key","required":true,"schema":{"type":"string"},"description":"Your General API Key for authentication and authorization."},{"in":"header","name":"Content-Type","required":true,"schema":{"type":"string","default":"application/json"}}]}}}}
```

--------------------------------

### GET /payment/accepted-currencies

Source: https://docs.oxapay.com/api-reference/payment/accepted-currencies.md

Retrieves the list of cryptocurrency symbols that are currently accepted for payments by the merchant.

```APIDOC
## GET /payment/accepted-currencies

### Description
Retrieves the list of cryptocurrency symbols that are currently accepted for payments by the merchant.

### Method
GET

### Endpoint
https://api.oxapay.com/v1/payment/accepted-currencies

### Parameters
#### Header Parameters
- **merchant_api_key** (string) - Required - Your Merchant API Key for authentication and authorization.
- **Content-Type** (string) - Required - Defaults to application/json.

### Response
#### Success Response (200)
- **data** (object) - Contains the list of accepted currencies.
- **data.list** (array) - An array containing the cryptocurrency symbols that are accepted for payments.
- **message** (string) - A message containing additional information about the result of the request.
- **status** (integer) - The status of the request response.
- **version** (string) - The version of the API being used.
```

--------------------------------

### POST /general/swap/calculate

Source: https://docs.oxapay.com/api-reference/swap/swap-calculate.md

Calculates the amount of cryptocurrency received when swapping from one currency to another based on real-time rates.

```APIDOC
## POST /general/swap/calculate

### Description
Calculates the amount of cryptocurrency received when swapping from one currency to another based on real-time rates.

### Method
POST

### Endpoint
/general/swap/calculate

### Parameters
#### Header Parameters
- **general_api_key** (string) - Required - Your General API Key for authentication and authorization.
- **Content-Type** (string) - Required - Must be set to application/json.

#### Request Body
- **from_currency** (string) - Required - Specify the currency symbol you want to swap from.
- **to_currency** (string) - Required - Specify the currency symbol you want to swap to.
- **amount** (number) - Required - Specify the amount of currency you want to swap.

### Response
#### Success Response (200)
- **data** (object) - Contains the swap details.
  - **to_amount** (number) - The amount of the "to_currency" received after the swap.
  - **rate** (number) - The swap rate between the currencies.
  - **amount** (number) - The amount of the "from_currency" being swapped.
- **message** (string) - A message containing additional information about the result.
- **status** (integer) - The status code of the request.
- **version** (string) - The API version.
```

--------------------------------

### GET /payout

Source: https://docs.oxapay.com/api-reference/payout/payout-history.md

Retrieves a list of payout transactions associated with the account, supporting filtering and pagination.

```APIDOC
## GET /payout

### Description
Retrieves a list of payout transactions associated with your account. Results can be filtered by criteria such as time range, status, amount, currency, network, and type, with support for pagination.

### Method
GET

### Endpoint
https://api.oxapay.com/v1/payout

### Response
#### Success Response (200)
- **data** (object) - Contains the list of payouts and pagination metadata.
  - **list** (array) - Array of payout objects.
    - **track_id** (string) - Unique identifier for the payout session.
    - **address** (string) - The cryptocurrency wallet address.
    - **currency** (string) - The cryptocurrency symbol.
    - **network** (string) - The blockchain network.
    - **amount** (number) - The total amount of the payout.
    - **fee** (number) - The fee associated with the payout.
    - **status** (string) - The current status of the payout.
    - **tx_hash** (string) - Unique transaction hash.
    - **description** (string) - Additional details related to the payout.
    - **internal** (boolean) - Flag indicating if the transaction is internal or external.
    - **memo** (string) - Optional memo field.
    - **date** (integer) - Timestamp (UNIX epoch) of the payout.
  - **meta** (object) - Pagination information.
    - **page** (integer) - Current page number.
    - **last_page** (integer) - Total number of pages.
    - **total** (integer) - Total number of records.
- **message** (string) - Additional information about the result.
- **status** (integer) - The status code of the response.
- **version** (string) - The API version.
```

--------------------------------

### GET /payment/{track_id}

Source: https://docs.oxapay.com/api-reference/payment/payment-information.md

Retrieves the details of a payment session based on the provided track ID.

```APIDOC
## GET /payment/{track_id}

### Description
Retrieves the status and details of a payment session using a unique track ID.

### Method
GET

### Endpoint
/payment/{track_id}

### Parameters
#### Path Parameters
- **track_id** (string) - Required - Unique identifier for the payment session.

#### Headers
- **merchant_api_key** (string) - Required - Your Merchant API Key for authentication and authorization.
- **Content-Type** (string) - Required - Defaults to application/json.

### Response
#### Success Response (200)
- **data** (object) - Payment session details.
- **message** (string) - Information about the request result.
- **status** (integer) - Numeric status code.
- **version** (string) - API version.

#### Error Response (400)
- **error** (object) - Details about the error including type, key, and message.
```
Tokens:
Raw