# 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 /payout

>

```json
{"openapi":"3.0.0","info":{"title":"Payouts","version":"1.0.0"},"servers":[{"url":"https://api.oxapay.com/v1"}],"security":[],"paths":{"/payout":{"get":{"operationId":"payoutHistory","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"track_id":{"type":"string","description":"Unique identifier for the payout session, used for tracking the payout status."},"address":{"type":"string","description":"The cryptocurrency wallet address where the payout is expected to be sent."},"currency":{"type":"string","description":"The cryptocurrency symbol in which the payout is made (e.g., BTC, ETH, USDT)."},"network":{"type":"string","description":"The blockchain network associated with the cryptocurrency, e.g., 'Bitcoin Network' or 'Ethereum Network'."},"amount":{"type":"number","format":"decimal","description":"The total amount of the payout in the specified currency."},"fee":{"type":"number","format":"decimal","description":"The fee associated with processing the payout."},"status":{"type":"string","description":"The current status of the payout, e.g., pending, confirmed, rejected, etc."},"tx_hash":{"type":"string","description":"Unique transaction hash for the transaction on the blockchain."},"description":{"type":"string","description":"A description providing additional details related to the payout or the transaction."},"internal":{"type":"boolean","description":"Flag indicating whether the transaction is internal or external."},"memo":{"type":"string","description":"An optional memo field for including additional details or a note regarding the payout."},"date":{"type":"integer","description":"Timestamp (UNIX epoch) representing when the payout."}}}},"meta":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number of the result set."},"last_page":{"type":"integer","description":"The total number of pages available based on the number of records and page size."},"total":{"type":"integer","description":"The total number of payments available for the specified criteria."}}}}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors)."},"version":{"type":"string","description":"The version of the API being used."}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{}},"message":{"type":"string","description":"A message containing additional information about the result of the request."},"error":{"type":"object","description":"An object that provides details about any errors that occurred.","nullable":true,"properties":{"type":{"type":"string","description":"Type of the error"},"key":{"type":"string","description":"Key related to the error"},"message":{"type":"string","description":"Error message"}}},"status":{"type":"integer","description":"The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors)."},"version":{"type":"string","description":"The version of the API being used."}}}}}}},"tags":["Payout-history"],"parameters":[{"in":"header","name":"payout_api_key","required":true,"schema":{"type":"string"},"description":"Your Payout API Key for authentication and authorization."},{"in":"header","name":"Content-Type","required":true,"schema":{"type":"string","default":"application/json"}},{"name":"status","in":"query","description":"Filter payouts based on their status (processing, complete, rejected, etc.).","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter payouts based on type.","required":false,"schema":{"type":"string","enum":["external","internal"]}},{"name":"currency","in":"query","description":"Specify the currency symbol for filtering payouts in a specific currency.","required":false,"schema":{"type":"string"}},{"name":"network","in":"query","description":"Specify the blockchain network for filtering payouts on a particular network.","required":false,"schema":{"type":"string"}},{"name":"from_amount","in":"query","description":"Specify the minimum payout amount for filtering.","required":false,"schema":{"type":"number","format":"decimal"}},{"name":"to_amount","in":"query","description":"Specify the maximum payout amount for filtering.","required":false,"schema":{"type":"number","format":"decimal"}},{"name":"from_date","in":"query","description":"The start of the date window to query for payouts in UNIX format.","required":false,"schema":{"type":"integer"}},{"name":"to_date","in":"query","description":"The end of the date window to query for payouts in UNIX format.","required":false,"schema":{"type":"integer"}},{"name":"sort_by","in":"query","description":"Sort the received list by a parameter.","required":false,"schema":{"type":"string","enum":["create_date","pay_date","amount"],"default":"create_date"}},{"name":"sort_type","in":"query","description":"Display the list in ascending or descending order.","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"size","in":"query","description":"Number of records to be displayed on one page.","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":10}},{"name":"page","in":"query","description":"The page number of the results you want to retrieve.","required":false,"schema":{"type":"integer","minimum":1,"default":1}}]}}}}
```


---

# 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/api-reference/payout/payout-history.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.