Version 2.4.7.20261116085428 · latest

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.

BillingAuthentication: Admin only3 endpoints

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.

GET/api/v2/usdt-transfersList USDT transfers

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
statestring Filter by state.
Values ["matched","unmatched","credited","ignored"]
startstring Block time from (inclusive), RFC 3339.
endstring Block time until (exclusive), RFC 3339.
POST/api/v2/usdt-transfers/{id}/creditCredit USDT transfer manually

Authentication: Admin only

Request body application/json

FieldTypeDescription
amount_centsRequiredinteger 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.
rateRequiredstring 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_idRequiredinteger Tenant ID to credit.
POST/api/v2/usdt-transfers/{id}/ignoreIgnore USDT transfer

Authentication: Admin only

USDT transfers object

FieldTypeDescription
amountstring USDT received (4 decimals).
amount_centsRequiredinteger 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_atstring Block time on chain.
candidateobject The likely matching order (closest-amount unpaid order to the same address within a day); null if none.
from_addressstring Sender address.
handled_atstring When it was handled manually.
handled_bystring Who handled it (manual credit/ignore).
idinteger Record ID
order_idinteger The recharge order credited (set after automatic or manual crediting).
rateRequiredstring 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).
reasonstring 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).
Values ["","underpaid","overpaid","expired","no_order","credit_failed","dust"]
statestring matched = credited automatically; unmatched = pending; credited = credited manually; ignored = ignored.
Values ["matched","unmatched","credited","ignored"]
tenant_idRequiredinteger Tenant ID to credit.
to_addressstring Receiving address (one of the channel's addresses).
txidstring 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.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "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"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command