GET /v1/payment/

Returns a paginated list of payments. Requires authentication.

Request

GET /v1/payment/

Query Parameters

Parameter	Type	Description
limit	number	Results per page (1–500, default 10)
page	number	Page number (0-indexed, default 0)
sortBy	string	Field to sort by (default created_at)
orderBy	string	asc or desc
dateFrom	string	Filter from date (ISO 8601)
dateTo	string	Filter to date (ISO 8601)

Sortable Fields

payment_id, payment_status, pay_address, price_amount, price_currency, pay_amount, actually_paid, pay_currency, order_id, order_description, purchase_id, outcome_amount, outcome_currency, created_at, updated_at

Example

curl "https://api.nearpayments.io/v1/payment/?limit=10&page=0&orderBy=desc" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "data": [
    {
      "payment_id": 1,
      "payment_status": "finished",
      "pay_address": "bc1q...",
      "price_amount": 25.50,
      "price_currency": "usd",
      "pay_amount": 0.00029,
      "actually_paid": 0.00029,
      "pay_currency": "btc",
      "order_id": "order-42",
      "order_description": null,
      "purchase_id": 5234123456,
      "outcome_amount": 25.50,
      "outcome_currency": "usdc",
      "invoice_id": null,
      "payin_extra_id": null,
      "payin_hash": null,
      "payout_hash": null,
      "burning_percent": "null",
      "type": "crypto2crypto",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:35:00.000Z"
    }
  ],
  "limit": 10,
  "page": 0,
  "pagesCount": 1,
  "total": 1
}