Payout History

This endpoint retrieves a list of payout transactions associated with your account, based on your Payout API Key. You can filter the results by various criteria, including time range, status, amount, currency, network, type (internal or external), and more. Additionally, pagination allows you to retrieve the results in smaller, manageable sets.

GET https://api.oxapay.com/v1/payout

Authentication

You must include the Payout API Key in the request header to authenticate your access to the API.

Name	Type	Description
payout_api_key*	string	Your Payout API Key for authentication and authorization.

Request Params

Name	Type	Description
status	string	Filter payouts based on their status (processing, complete, rejected, etc.).
type	string	Filter payouts based on type (internal or external).
currency	string	Specify the currency symbol for filtering payouts in a specific currency.
network	string	Specify the blockchain network for filtering payouts on a particular network.
from_amount	decimal	Specify the minimum payout amount for filtering.
to_amount	decimal	Specify the maximum payout amount for filtering.
from_date	integer	The start of the date window to query for payouts in unix format
to_date	integer	The start of the date window to query for payouts in unix format
sort_by	string	Sort the received list by a parameter. Set to 'create_date' by default. Possible values: 'create_date', 'pay_date', 'amount' [default 'create_date'].
sort_type	string	Display the list in ascending or descending order. Possible values: 'asc', 'desc' [default 'desc'].
size	integer	Number of records to be displayed on one page. Possible values: from 1 to 200 - default 10.
page	integer	The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1.

200: OK

{
  "data": {
    "list": 
        {
          "track_id": string, // Unique identifier for the payout session, used for tracking the payout status.
          "address": string, // The cryptocurrency wallet address where the payout is expected to be sent.
          "currency": string, // The cryptocurrency symbol in which the payout is made (e.g., BTC, ETH, USDT).
          "network": string, // The blockchain network associated with the cryptocurrency, e.g., "Bitcoin Network" or "Ethereum Network".
          "amount": decimal, // The total amount of the payout in the specified currency.
          "fee": decimal, // The fee associated with processing the payout.
          "status": string, // The current status of the payout, e.g., pending, confirmed, rejected, etc.
          "tx_hash": string, // Unique transaction hash for the transaction on the blockchain.
          "description": string, // A description providing additional details related to the payout or the transaction.
          "internal": boolean, // Flag indicating whether the transaction is internal or external.
          "memo": string, // An optional memo field for including additional details or a note regarding the payout.
          "date": integer // Timestamp (UNIX epoch) representing when the payout.
      }[],
    "meta": {
      "page": integer, // The current page number of the result set.
      "last_page": integer, // The total number of pages available based on the number of records and page size.
      "total": integer // The total number of payments available for the specified criteria.
    },
  },
  "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/payout/?size=20&page=1" \
    -H "payout_api_key: YOUR_PAYOUT_API_KEY" \
    -H "Content-Type: application/json"

PHP

<?php

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

$data = array(
    'size' => 20,
    'page' => 1
);

$query = http_build_query($data);
$url = $url . '?' . $query;

$headers = [
    'Content-Type: application/json',
    'payout_api_key: YOUR_PAYOUT_API_KEY'
];

$options = array(
    'http' => array(
        'header'  => implode("\r\n", $headers),
        '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/payout/';
​
const params = {
    size: 20,
    page: 1
};

const headers = {
  'payout_api_key': `YOUR_PAYOUT_API_KEY`,
  'Content-Type': 'application/json',
};
​
axios.get(url, { params, headers })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests
import json

url = 'https://api.oxapay.com/v1/payout/'

params = {
  'size': 20,
  'page': 1
}

headers = {
    'payout_api_key': 'YOUR_PAYOUT_API_KEY ',
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params , headers=headers)
result = response.json()
print(result)

Please make sure to replace YOUR_PAYOUT_API_KEY in the code snippets with your actual Payout API Key.

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

API Response Example

{
    "data": {
        "list": [
            {
                "track_id": "258298351",
                "address": "1AmH3Qz2LooYa1YSyLhySuatwoRMsfznPJ",
                "currency": "BTC",
                "network": "Bitcoin Network",
                "amount": 0.0200000000,
                "fee": 0.0000100000,
                "status": "processing",
                "tx_hash": "",
                "description": "test",
                "internal": false,
                "memo": "test",
                "date": 1736501470
            }
        ],
        "meta": {
            "page": 1,
            "last_page": 1,
            "total": 1
        }
    },
    "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.