List All Payments — GET /payments

Returns a paginated list of payments for your account, newest first. Supports filtering by status, asset, date range, and amount, as well as customisable sort order. Requires the payments:read scope.

Request

GET https://api.blockra.io/payments

Query parameters

page

integer

default:"1"

Page number (1-based).

limit

integer

default:"25"

Items per page. Maximum 100.

sort

string

Field to sort by: id, total, asset, status, or created_at. Defaults to created_at.

order

string

default:"desc"

Sort direction: asc or desc.

filter_id

string

Filter to an exact payment ID.

filter_email

string

Substring match on the associated customer email.

filter_asset

string

Comma-separated list of coins to include (e.g. BTC,ETH). Pair with filter_asset_op=is_not to exclude the listed assets.

filter_asset_op

string

Operator for filter_asset: is (include, default) or is_not (exclude).

filter_status

string

Comma-separated statuses to include (e.g. completed,pending). Pair with filter_status_op=is_not to exclude.

filter_status_op

string

Operator for filter_status: is (include, default) or is_not (exclude).

total_min

number

Minimum net fiat amount filter.

total_max

number

Maximum net fiat amount filter.

start_date

string

ISO date string — return payments created on or after this date (e.g. 2026-01-01).

end_date

string

ISO date string — return payments created before this date.

Response

Returns a 200 with a paginated result object wrapped in the standard data envelope.

items

array

Array of payment objects for the current page.

total

integer

Total number of payments matching the current filters.

curl "https://api.blockra.io/payments?limit=10&filter_status=completed&sort=created_at&order=desc" \
  -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

const params = new URLSearchParams({
  limit: "10",
  filter_status: "completed",
  sort: "created_at",
  order: "desc",
});
const res = await fetch(`https://api.blockra.io/payments?${params}`, {
  headers: { "X-API-Key": process.env.BLOCKRA_API_KEY! },
});
const { data } = await res.json();
// data.items is the array of payments

{
  "data": {
    "items": [
      {
        "id": "pay_a1b2c3d4e5f6g7h8i9j0k1l2",
        "status": "completed",
        "asset": "LTC",
        "net_fiat": 9.77,
        "fiat_currency": "USD",
        "reference": "order_1234",
        "created_at": "2026-07-08T12:39:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 10,
    "total_pages": 1
  },
  "error": null
}

​Request

​Query parameters

​Response

Request

Query parameters

Response