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

# GET /payment

`GET /payment`

## Query parameters

- `track_id` integer
- `type` 'invoice' | 'white_label' | 'static_address'
- `status` 'Paying' | 'Paid'
- `pay_currency` string
- `currency` string
- `network` string
- `address` string
- `from_date` integer
- `to_date` integer
- `from_amount` number
- `to_amount` number
- `sort_by` 'create_date' | 'pay_date' | 'amount'
- `sort_type` 'asc' | 'desc'
- `page` integer
- `size` integer

## Headers

- `merchant_api_key` string, required
- `Content-Type` string, required

## Response `200`

Successful operation

- object
  - `data` object
    - `list` object[]
      - `track_id` string — Unique identifier for each payment session in the OxaPay payment gateway. It is used to track the payment status and generate reports.
      - `type` string — Describes the payment type, e.g., invoice, white-label, etc.
      - `amount` number — The total amount of the invoice in the specified currency.
      - `currency` string — The currency of the payment, e.g., USD, EUR, BTC.
      - `status` string — The current status of the invoice, such as pending, completed, failed, etc.
      - `mixed_payment` boolean — A flag indicating whether the payment is mixed (involving multiple payment currencies).
      - `callback_url` string — The URL to which payment status updates will be sent.
      - `description` string — A description for the invoice.
      - `email` string — The email address of the payer.
      - `fee_paid_by_payer` number — Indicates if the payer is responsible for paying the network fees (1 = yes, 0 = no).
      - `lifetime` integer — The lifetime of the invoice in minutes before it expires.
      - `order_id` string — A unique identifier for the order associated with this invoice.
      - `under_paid_coverage` number — The percentage of underpayment that will still be considered valid.
      - `return_url` string — The URL the user will be redirected to after completing the payment.
      - `thanks_message` string — A custom message to thank the user for the payment.
      - `expired_at` integer — Timestamp (UNIX epoch) when the invoice will expire.
      - `date` integer — Timestamp (UNIX epoch) of when the invoice was created.
      - `txs` object[]
        - `tx_hash` string — Unique hash of the transaction on the blockchain, used to identify the transaction.
        - `amount` number — The amount involved in the transaction.
        - `currency` string — The currency of the transaction.
        - `network` string — The blockchain network on which the transaction was made (e.g., Bitcoin, Ethereum).
        - `address` string — The receiver wallet address.
        - `status` string — The current status of the transaction, such as confirming, confirmed, failed, etc.
        - `confirmations` integer — The number of confirmations the transaction has received on the network.
        - `auto_convert` object
          - `processed` boolean — Indicates whether the transaction was automatically converted to another currency.
          - `amount` number — The amount of currency that was converted.
          - `currency` string — The currency to which the amount was converted.
        - `auto_withdrawal` object
          - `processed` boolean — Indicates whether the funds were automatically withdrawn after the transaction.
        - `date` integer — The timestamp when the transaction occurred.
    - `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.net/oxapay/apis/payments.md) · [All operations](https://skmtc.net/oxapay/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oxapay/payments/versions/19b6abc20c8d/schema)