---
title: "GET /payout"
method: GET
path: "/payout"
tags: ["Payout-history"]
---

# GET /payout

`GET /payout`

## Query parameters

- `status` string
- `type` 'external' | 'internal'
- `currency` string
- `network` string
- `from_amount` number
- `to_amount` number
- `from_date` integer
- `to_date` integer
- `sort_by` 'create_date' | 'pay_date' | 'amount'
- `sort_type` 'asc' | 'desc'
- `size` integer
- `page` integer

## Headers

- `payout_api_key` string, required
- `Content-Type` string, required

## Response `200`

Successful operation

- object
  - `data` object
    - `list` object[]
      - `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` number — The total amount of the payout in the specified currency.
      - `fee` number — 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.
    - `meta` object
      - `page` integer — The current page number of the result set.
      - `last_page` integer — The total number of pages available based on the number of records and page size.
      - `total` integer — The total number of payments available for the specified criteria.
  - `message` string — A message containing additional information about the result of the request.
  - `error` object, nullable — An object that provides details about any errors that occurred.
    - `type` string — Type of the error
    - `key` string — Key related to the error
    - `message` string — Error message
  - `status` integer — The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).
  - `version` string — The version of the API being used.

## Other responses

- `400` — Bad request

---

[API](https://skmtc.dev/oxapay/apis/payments.md) · [All operations](https://skmtc.dev/oxapay/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oxapay/payments/revisions/19b6abc20c8d/schema)