Hex Pay Docs
API Reference

List payments

Returns a paginated list of payments for your store, ordered by creation date (most recent first).

Use cursor-based pagination: if the response contains a cursor field, pass its value as the cursor query parameter to fetch the next page. The absence of cursor in the response means there are no more pages.

Use the status parameter to filter payments by one or more statuses.

GET
/v1/payments
AuthorizationBearer <token>

JWT token signed with the EdDSA algorithm. Obtain the token from the HexPay merchant dashboard and pass it via the Authorization: Bearer <token> header.

In: header

Query Parameters

limit?integer

Maximum number of payment objects to return per page. Accepts values between 1 and 100. Defaults to 10.

Default10
Range1 <= value <= 100
cursor?string

Pagination cursor. Pass the value of cursor from the previous response unchanged to retrieve the next page of results. The cursor is an opaque string; do not parse or construct it.

status?array<PaymentStatus>

Filter payments by status. Accepts a comma-separated list of statuses. Returns payments matching any of the provided values. Omit to return payments in all statuses.

Response Body

curl -X GET "https://api.hexpay.io/v1/payments?limit=20&cursor=019327c6-1234-7901-b234-56789abcde00&status=pending%2Ccompleted"

{
  "data": [
    {
      "id": "019327c6-2058-7901-b234-56789abcdeff",
      "status": "completed",
      "orderId": "order-2026-00123",
      "amount": "100.00",
      "currency": "USD",
      "checkoutUrl": "https://payment.hexpay.io/019327c6-2058-7901-b234-56789abcdeff",
      "timer": {
        "createdAt": "2026-01-20T10:00:00Z",
        "expiresAt": "2026-01-20T11:00:00Z",
        "paidAt": "2026-01-20T10:12:00Z"
      }
    },
    {
      "id": "019327c6-1234-7901-b234-56789abcde00",
      "status": "pending",
      "orderId": "order-2026-00124",
      "amount": "50.00",
      "currency": "EUR",
      "checkoutUrl": "https://payment.hexpay.io/019327c6-1234-7901-b234-56789abcde00",
      "timer": {
        "createdAt": "2026-01-20T09:30:00Z",
        "expiresAt": "2026-01-20T10:30:00Z"
      }
    }
  ],
  "cursor": "019327c6-1234-7901-b234-56789abcde00"
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "limit must be between 1 and 100",
    "code": "invalid_limit",
    "param": "limit"
  }
}

{
  "error": {
    "type": "authentication_error",
    "message": "Missing authorization token",
    "code": "auth_missing"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "Internal server error",
    "code": "internal_error"
  }
}