# 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.

<mark style="color:green;">`POST`</mark> `https://api.oxapay.com/api/inquiry`

#### Request Body

<table><thead><tr><th width="113">Name</th><th width="100">Type</th><th width="541">Description</th></tr></thead><tbody><tr><td>key<mark style="color:red;">*</mark></td><td>string</td><td>Your payout API key for authentication and authorization.</td></tr><tr><td>trackId<mark style="color:red;">*</mark></td><td>integer</td><td>The unique identifier of each payout request from OxaPay. Use this TrackId to query the payout status and obtain detailed payout information.</td></tr></tbody></table>

{% tabs %}
{% tab title="200: OK " %}

```json
{
  "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.
}
```

{% endtab %}
{% endtabs %}

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](/legacy/api-reference/result-code-table.md) for further details.

### Example codes

{% tabs %}
{% tab title="cURL" %}

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

{% endtab %}

{% tab title="PHP" %}

```php
<?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);
?>
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
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);
    });
```

{% endtab %}

{% tab title="Python" %}

```python
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)
```

{% endtab %}
{% endtabs %}

Please replace `YOUR_PAYOUT_API_KEY` with your actual payout API key, and`TRACK_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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.oxapay.com/legacy/api-reference/payout-information.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.