Payout Information

This endpoint retrieves the details of a specific payout using its track_id. After generating a payout request, you will receive a track_id, which can be used to obtain detailed information about the payout.

GET https://api.oxapay.com/v1/payout/{track_id}

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.

200: OK

{
    "data": {
        "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.
    },
    "message": "Operation completed successfully!",
    "error": {},
    "status": 200,
    "version": "1.0.3"
}

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/{track_id}\
  -H "payout_api_key: YOUR_PAYOUT_API_KEY" \
  -H "Content-Type: application/json" 

PHP

<?php

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

$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 track_id = 'TRACK_ID';
const url = `https://api.oxapay.com/v1/payout/${track_id}`;

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

axios.get(url, { headers })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests
import json

track_id = 'TRACK_ID'
url = f'https://api.oxapay.com/v1/payout/{track_id}'

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

response = requests.get(url, 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 Information" endpoint using different programming languages. You can customize the data parameters according to your specific requirements.

API Response Example

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