Your unique dashboard id provided to you by WristCoin
<aside>
🚨 A terminal_timestamp range of less than or equal to 2 months is required for this endpoint.
</aside>
No query parameters are required, however pagination, sorting, and filtering is supported in this endpoint using the parameters below
| Key | Description of Value | Examples |
|---|---|---|
sort |
The priority and order of the sorting. The topup report endpoint only supports sorting by terminal_timestamp |
terminal_timestamp:desc |
limit |
The maximum number of records you want returned |
Note: A sort parameter is required if specifying a limit | 10 |
| terminal_timestamp | The range of sales timestamps you want to get, specified in Unix time | gte:1704117600 |
| tx_type | enum
Used to filter for the tender/payment type. It is an enumerated type of tender types supported by WristCoin. See below for more information | creditIntegrated |
| employee_id | Used to filter for a unique identifier of the employee that made the topup | d7c313a8-4318-4ff0-835c-debc31f7a922 |
| topup_tx_amount | Used to filter the topup amount, specified in centavos/cents as an int | 1500 |
<aside> 💡 To include both a greater than or equal to, and a less than or equal for time/date filters, use the same key twice in the query parameters. For example to query a time/date range:
/reports/topups?terminal_timestamp=gte:1704117600&terminal_timestamp=lte:1710622800
</aside>
The following values are supported for specifying tx_type:
Value for tx_type |
Comment |
|---|---|
standard |
Used to specify cash as a tender as would be shown in the options of tender type in the mPOS. |
creditExternal |
Card present credit card payment using a card processing terminal external to WristCoin |
debitExternal |
Card present debit card payment using a card processing terminal external to WristCoin |
creditIntegrated |
Card present credit card payment using a card processing terminal directly integrated with WristCoin |
debitIntegrated |
Card present debit card payment using a card processing terminal directly integrated with WristCoin |
nonmonetary |
|
other |
None
| Response Body | |
|---|---|
| 200 | A topup_report object |
| 401/403 | `"error_code": 0, |
"error_message": "A valid authorization was not present",
"http_status": 403` |