OxaPay Docs
Legacy
Legacy
  • Introduction
  • Getting Started
  • Integrations
    • Payment Links
    • Donations
    • Merchant API
    • Payout API
    • Plugins
      • WooCommerce
      • WISECP
      • Clientexec
      • Blesta
      • WHMCS
      • PrestaShop
      • Easy Digital Downloads
      • Paid Memberships Pro
      • Gravity Forms
      • Restrict Content Pro
      • VirtueMart
    • Merchant and Payout Service with API
  • API Reference
    • Creating an Invoice
    • Creating White-Label Payment
    • Creating Static Wallet
    • Revoking Static Wallet
    • Static Wallets List
    • Payment Information
    • Payment History
    • Accepted Coins
    • Price
    • Creating Payout
    • Payout Information
    • Payout History
    • Account Balance
    • Exchange Rate
    • Exchange Calculate
    • Exchange Pairs
    • Exchange Request
    • Exchange History
    • Supported Currencies
    • Supported Fiat Currencies
    • Supported Networks
    • System Status
    • Result code table
    • Merchant status table
    • Payout status table
  • Webhook
  • Use Cases
  • Troubleshooting
Powered by GitBook
On this page
  1. API Reference

Payout History

Use this endpoint to retrieve a list of payout transactions for a specific business. The list can be filtered by various criteria, such as time range, status, amount, currency, network, type (internal or external), and more. Pagination is also available to fetch the results in smaller sets.

POST https://api.oxapay.com/api/list

Request Body

Name
Type
Description

key*

string

Your Payout API key for authentication and authorization.

orderBy

string

Display the list in ascending or descending order. Possible values: 'asc', 'desc' [default 'desc'].

sortBy

string

Sort the received list by a parameter. Set to 'create_date' by default. Possible values: 'create_date', 'pay_date', 'amount' [default 'create_date'].

page

integer

The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1.

size

integer

Number of records to be displayed on one page. Possible values: from 1 to 200 - default 10.

status

string

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

type

string

Filter payouts based on type (internal or external).

network

string

currency

string

toAmount

string

Specify the maximum payout amount for filtering.

fromAmount

string

Specify the minimum payout amount for filtering.

toDate

string

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

fromDate

string

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

{
  "result": integer, // The result code indicates the success or failure of the request.
  "message": string, // A message providing additional information about the result.
  "data": [
    {
      "id": string, // The unique identifier of the payout transaction.
      "address": string, // The recipient's cryptocurrency address for the payout.
      "currency": string, // The cryptocurrency symbol of the payout.
      "network": string, // The blockchain network associated with the cryptocurrency.
      "amount": string, // The amount of cryptocurrency sent in the payout.
      "fee": string, // The transaction fee (if any) associated with the payout.
      "status": string, // The status of the payout transaction (e.g., \"complete\", \"processing\", \"rejected\").
      "type": string, // The type of the payout (e.g., \"internal\" or \"external\").
      "txID": string, // The transaction ID of the payout on the blockchain (if available).
      "date": string, // The timestamp of the payout transaction in Unix time format.
      "description": string // Additional information or description related to the payout transaction.
    }
  ],
  "meta": {
    "size": integer, // The number of payout transactions returned in the current page.
    "page": integer, // The current page number of the result set.
    "pages": integer, // The total number of pages available based on the number of records and page size.
    "total": integer // The total number of payout transactions available for the specified criteria.
  }
}

Please note that this response sample includes a list of payout transactions with their respective details and a metadata section providing information about the total number of records and pages available.

Example codes

curl -X POST https://api.oxapay.com/api/list \
  -d '{
    "key": "YOUR_PAYOUT_API_KEY",
    "fromDate": 1690848000,
    "toDate": 1691625600,
    "size": 20,
    "page": 1
  }'
<?php

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

$data = array(
    'key' => 'YOUR_MERCHANT_API_KEY',
    'fromDate' => 1690848000,
    'toDate' => 1691625600,
    'size' => 20,
    'page' => 1
);

$options = array(
    'http' => array(
        'header' => 'Content-Type: application/json',
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
$result = json_decode($response);
var_dump($result);
?>
const axios = require('axios');
const url = 'https://api.oxapay.com/api/list';
const data = JSON.stringify({
    key: 'YOUR_MERCHANT_API_KEY',
    fromDate: 1690848000,
    toDate: 1691625600,
    size: 20,
    page: 1
});

axios.post(url, data)
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(error);
    });
import requests
import json

url = 'https://api.oxapay.com/api/list'
data = {
  'key': 'YOUR_MERCHANT_API_KEY',
  'fromDate': 1690848000,
  'toDate': 1691625600,
  'size': 20,
  'page': 1
}
response = requests.post(url, data=json.dumps(data))
result = response.json()
print(result)

Please remember to replace YOUR_PAYOUT_API_KEY with your actual payout API key and adjust the parameters as needed for your specific use case.

PreviousPayout InformationNextAccount Balance

Last updated 1 month ago

Specify the blockchain for filtering payouts on a particular network.

Specify the for filtering payouts in a specific currency.

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

result codes
network
currency symbol