Developer API

HOT PAY HTTP REST API documentation

Authorization

Get JWT to use partner API on the developer page

Get Processed Payments

get

Returns a paginated list of processed payments. Authentication is required. API token must be generated in the Admin Panel and passed via the Authorization header.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

item_idstringOptional

Identifier of the payment link (item).

memostringOptional

Merchant-defined memo or order identifier.

sender_idstringOptional

Sender wallet address or account identifier.

limitinteger · max: 1000Optional

Maximum number of payments to return.

Default: 100

offsetintegerOptional

Number of payments to skip before starting to return results.

Default: 0

Header parameters

AuthorizationstringRequired

Partner API token generated in the Admin Panel. Format: Authorization: <API_TOKEN>

Responses

200

Successfully retrieved processed payments

application/json

401

Unauthorized — invalid or missing Authorization token

get

/partners/processed_payments

HTTPcURLJavaScriptPython

GET /partners/processed_payments HTTP/1.1
Host: api.hot-labs.org
Authorization: text
Accept: */*

{
  "payments": [
    {
      "memo": "text",
      "item_id": "text",
      "timestamp": 1,
      "amount": "text",
      "token_id": "text",
      "sender_id": "text",
      "near_trx": "text",
      "status": "SUCCESS"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "count": 1
  }
}