Payment History

Use this endpoint to retrieve a list of payments associated with your account, determined by your Merchant API Key. You can filter the results using various criteria, including time range, payment status, amount, payment type, and more. Additionally, the endpoint supports pagination with page and size parameters, allowing you to customize the number of results per request.

get

Query parameters

track_idintegerOptional

Filter payments by a specific invoice ID.

typestring · enumOptional

Filter payments by type.

Possible values:

statusstring · enumOptional

Filter payments by status.

Possible values:

pay_currencystringOptional

Filter payments by a specific crypto currency symbol in which the pay amount is specified.

currencystringOptional

Filter payments by a specific currency symbol.

networkstringOptional

Filter payments by the expected blockchain network for the specified crypto currency.

addressstringOptional

Filter payments by the expected address. It’s better to filter static addresses.

from_dateintegerOptional

The start of the date window to query for payments in UNIX format.

to_dateintegerOptional

The end of the date window to query for payments in UNIX format.

from_amountnumber · decimalOptional

Filter payments with amounts greater than or equal to the specified value.

to_amountnumber · decimalOptional

Filter payments with amounts less than or equal to the specified value.

sort_bystring · enumOptional

Sort the received list by a parameter.

Default: create_datePossible values:

sort_typestring · enumOptional

Display the list in ascending or descending order.

Default: descPossible values:

pageinteger · min: 1Optional

The page number of the results you want to retrieve.

Default: 1

sizeinteger · min: 1 · max: 200Optional

Number of records to display per page.

Default: 10

Header parameters

merchant_api_keystringRequired

Your Merchant API Key for authentication and authorization.

Content-TypestringRequiredDefault: application/json

Responses

200

Successful operation

application/json

400

Bad request

application/json

get

PythoncURLPHPNode.js

import requests
import json

url = 'https://api.oxapay.com/v1/payment/'

headers = {
    'merchant_api_key': 'YOUR_MERCHANT_API_KEY',
    'Content-Type': 'application/json'
}

params = {
  'size': 20,
  'page': 1
}

response = requests.get(url, params=params , headers=headers)
result = response.json()
print(result)    

{
  "data": {
    "list": [
      {
        "track_id": "168931368",
        "type": "invoice",
        "amount": 15,
        "currency": "USD",
        "status": "paid",
        "mixed_payment": true,
        "fee_paid_by_payer": 0,
        "under_paid_coverage": 21.5,
        "lifetime": 60,
        "callback_url": "https://example.com/callback",
        "return_url": "https://example.com/success",
        "email": "[email protected]",
        "order_id": "ORD-12345",
        "description": "Order #12345",
        "thanks_message": "Thanks Message",
        "expired_at": 1728121075,
        "date": 1728117475,
        "txs": [
          {
            "tx_hash": "0x2DehmnxMDFMhS3KHXCPpGSx41NeLBjH34q5vjN1oGbUDFFAMC9rG3",
            "amount": 0.00613418,
            "currency": "ETH",
            "network": "Ethereum Network",
            "address": "HEHCVjnxD8cQrFwfo4k9WXJXErpmK9Ym1nRaEiJJ8DP3",
            "status": "confirmed",
            "confirmations": 11,
            "auto_convert": {
              "processed": true,
              "amount": 14.73130872,
              "currency": "USDT"
            },
            "auto_withdrawal": {
              "processed": false
            },
            "date": 1728117736
          }
        ]
      }
    ],
    "meta": {
      "page": 1,
      "last_page": 1,
      "total": 1
    }
  },
  "message": "Operation completed successfully!",
  "error": {},
  "status": 200,
  "version": "1.0.0"
}