# Developer API

### Authorization

Get JWT to use partner API on the developer page

<figure><img src="/files/4W8JJXwCPFBnH1iECiXL" alt=""><figcaption></figcaption></figure>

## Get Processed Payments

> 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.

```json
{"openapi":"3.0.3","info":{"title":"HOT Pay Partner API","version":"1.0.0"},"servers":[{"url":"https://api.hot-labs.org","description":"Production environment"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Payment":{"type":"object","properties":{"memo":{"type":"string","description":"Merchant-defined memo or order identifier."},"item_id":{"type":"string","description":"Identifier of the payment link (item)."},"timestamp":{"type":"integer","description":"Unix timestamp (seconds) when the payment was finalized."},"amount":{"type":"string","description":"Paid amount in the smallest unit of the token."},"token_id":{"type":"string","description":"Identifier of the token received by the merchant."},"sender_id":{"type":"string","description":"Wallet address or account that initiated the payment."},"near_trx":{"type":"string","description":"NEAR transaction hash associated with the payment."},"status":{"type":"string","description":"Current payment status.","enum":["PENDING","PROCESSING","SUCCESS","REFUNDED","FAILED","INCOMPLETE_DEPOSIT","PENDING_DEPOSIT","KNOWN_DEPOSIT_TX"]}}},"Pagination":{"type":"object","properties":{"limit":{"type":"integer","description":"Maximum number of items requested."},"offset":{"type":"integer","description":"Number of items skipped before this page."},"count":{"type":"integer","description":"Number of items returned in the current response."}}}}},"paths":{"/partners/processed_payments":{"get":{"summary":"Get Processed Payments","description":"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.","tags":["Payments"],"parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Partner API token generated in the Admin Panel. Format: Authorization: <API_TOKEN>"},{"name":"item_id","in":"query","required":false,"schema":{"type":"string"},"description":"Identifier of the payment link (item)."},{"name":"memo","in":"query","required":false,"schema":{"type":"string"},"description":"Merchant-defined memo or order identifier."},{"name":"sender_id","in":"query","required":false,"schema":{"type":"string"},"description":"Sender wallet address or account identifier."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"maximum":1000},"description":"Maximum number of payments to return."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0},"description":"Number of payments to skip before starting to return results."}],"responses":{"200":{"description":"Successfully retrieved processed payments","content":{"application/json":{"schema":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"description":"Unauthorized — invalid or missing Authorization token"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://hot-labs.gitbook.io/hot-pay/developer-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
