Payout Information

Use the Payout Information endpoint to retrieve the details of a specific payment by its trackId. After creating an invoice, you will receive a TrackId, which you can use to make payment information requests.

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

Request Body

Name

Type

Description

key*

string

Your payout API key for authentication and authorization.

trackId*

integer

The unique identifier of each payout request from OxaPay. Use this TrackId to query the payout status and obtain detailed payout information.

{
  "result": integer, // The result code indicates the success or failure of the request.
  "message": string, // A message providing additional information about the result.
  "trackId": string, // The unique identifier of the payment session.
  "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.
}

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

Example codes

curl -X POST https://api.oxapay.com/api/inquiry \
  -d '{
    "key": "YOUR_PAYOUT_API_KEY",
    "trackId": TRACK_ID
  }'

<?php

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

$data = array(
    'key' => 'YOUR_PAUOUT_API_KEY',
    'trackId' => 'TRACK_ID'
);

$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/inquiry';
const data = JSON.stringify({
    key: 'YOUR_PAYOUT_API_KEY',
    trackId: TRACK_ID
});

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/inquiry'
data = {
    'key': 'YOUR_PAYOUT_API_KEY',
    'trackId': TRACK_ID
}
response = requests.post(url, data=json.dumps(data))
result = response.json()
print(result)

Please replace YOUR_PAYOUT_API_KEY with your actual payout API key, andTRACK_ID with the unique identifier of the payout session (TrackId) you want to inquire about. These code snippets demonstrate how to make a POST request to the Payout Information endpoint and handle the response in each respective programming language.

PreviousCreating Payout NextPayout History

Last updated 4 months ago

hashtagRequest Body

hashtagExample codes

Request Body

Example codes