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

Query parameters

statusstringOptional

Filter payouts based on their status (processing, complete, rejected, etc.).

typestring · enumOptional

Filter payouts based on type.

Possible values:

currencystringOptional

Specify the currency symbol for filtering payouts in a specific currency.

networkstringOptional

Specify the blockchain network for filtering payouts on a particular network.

from_amountnumber · decimalOptional

Specify the minimum payout amount for filtering.

to_amountnumber · decimalOptional

Specify the maximum payout amount for filtering.

from_dateintegerOptional

The start of the date window to query for payouts in UNIX format.

to_dateintegerOptional

The end of the date window to query for payouts in UNIX format.

sort_bystring · enumOptional

Sort the received list by a parameter.

Default: create_datePossible values:

sort_typestring · enumOptional

Display the list in ascending or descending order.

Default: descPossible values:

sizeinteger · min: 1 · max: 200Optional

Number of records to be displayed on one page.

Default: 10

pageinteger · min: 1Optional

The page number of the results you want to retrieve.

Default: 1

Header parameters

payout_api_keystringRequired

Your Payout API Key for authentication and authorization.

Content-TypestringRequiredDefault: application/json

Responses

200

Successful operation

application/json

messagestringOptional

A message containing additional information about the result of the request.

statusintegerOptional

The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).

versionstringOptional

The version of the API being used.

400

Bad request

application/json

get

/payout

PythoncURLPHPNode.js

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)

{
  "data": {
    "list": [
      {
        "track_id": "258298351",
        "address": "1AmH3Qz2LooYa1YSyLhySuatwoRMsfznPJ",
        "currency": "BTC",
        "network": "Bitcoin Network",
        "amount": 0.02,
        "fee": 0.00001,
        "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"
}