Skip to main content

Get Transaction Status

Retrieve the latest state of a specific transaction by its internal id using your API key.

Request

GET /api/v1/transactions/{transaction_id}
Headers:
x-api-key: <your_api_key>

{transaction_id} is the transaction's internal id (UUID), passed as a path segment.

Response Fields

FieldDescription
amountAmount in minor units
amount_with_feeAmount including fee (minor units)
amount_destDestination amount for conversion (minor units), if applicable
currencyCurrency code (e.g. USDT)
currency_destDestination currency for conversion, if applicable
descriptionOriginal description provided
envEnvironment (prod or test)
error_descriptionError details if status is rejected
finishedFinish timestamp (ISO) if terminal
idInternal transaction identifier (UUID)
routeProcessing route used
startedStart timestamp (ISO)
statusCurrent status (see Status Lifecycle in Field Conventions; e.g. created, charging, charged, refunded, rejected, failed)
txidClient supplied external identifier
typeTransaction type (payment or payout)
widget_urlWidget link (if widget flow)
simple_auth_redirect_url3DS / additional auth URL when applicable

Example

curl --location 'https://app.heth.me/api/v1/transactions/c033ceaa-3726-4479-8be3-c9af8a0b2336' \
--header 'x-api-key: YOUR_KEY'

Usage Notes

  • Poll with exponential backoff (e.g. 1s, 2s, 4s, 8s) until a terminal state.
  • Treat missing finished as in-progress.
  • txid should be idempotent per business operation.