USDT transfers usdt-transfers
Each on-chain transfer into the USDT receiving addresses; those not matching an order are credited or ignored by admins.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/usdt-transfersList USDT transfers
Authentication: Admin only
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
state | string | Filter by state. |
start | string | Block time from (inclusive), RFC 3339. |
end | string | Block time until (exclusive), RFC 3339. |
/api/v2/usdt-transfers/{id}/creditCredit USDT transfer manually
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
amount_centsRequired | integer | Amount to credit, in cents of the tenant's account currency; must be within ±2% of the transfer's USDT × rate, otherwise 422 usdt_credit_mismatch. |
rateRequired | string | Rate recorded on the order (1 USDT = rate units of the account currency); a decimal greater than 0 with at most 10 integer and 8 fraction digits (no exponent, fraction or sign). |
tenant_idRequired | integer | Tenant ID to credit. |
/api/v2/usdt-transfers/{id}/ignoreIgnore USDT transfer
Authentication: Admin only
USDT transfers object
| Field | Type | Description |
|---|---|---|
amount | string | USDT received (4 decimals). |
amount_centsRequired | integer | Amount to credit, in cents of the tenant's account currency; must be within ±2% of the transfer's USDT × rate, otherwise 422 usdt_credit_mismatch. |
block_at | string | Block time on chain. |
candidate | object | The likely matching order (closest-amount unpaid order to the same address within a day); null if none. |
from_address | string | Sender address. |
handled_at | string | When it was handled manually. |
handled_by | string | Who handled it (manual credit/ignore). |
id | integer | Record ID |
order_id | integer | The recharge order credited (set after automatic or manual crediting). |
rateRequired | string | Rate recorded on the order (1 USDT = rate units of the account currency); a decimal greater than 0 with at most 10 integer and 8 fraction digits (no exponent, fraction or sign). |
reason | string | Why it was not credited automatically: underpaid/overpaid = paid less/more; expired = order expired; no_order = no order found; credit_failed = automatic crediting failed (e.g. the order tenant was deleted); dust = below the minimum order amount (ignored directly, no inbox message). |
state | string | matched = credited automatically; unmatched = pending; credited = credited manually; ignored = ignored. |
tenant_idRequired | integer | Tenant ID to credit. |
to_address | string | Receiving address (one of the channel's addresses). |
txid | string | On-chain transaction ID. |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}