Skip to main content
GET
Get Transaction
This endpoint requires HMAC-SHA256 authentication. See Authentication for signature computation details.

When to Use This Endpoint

  • After payment timeout - Check if the payment completed after a 504 response
  • Reconciliation - Verify transaction status for accounting purposes
  • Status polling - Check on pending transactions

Transaction Status Values

Voided Transactions

A transaction may be voided if:
  1. Terminal disconnected during payment processing
  2. 60-second grace period expired
  3. Terminal reconnected with a successful payment result
  4. Payment was automatically voided to prevent orphaned charges
A Voided transaction was auto-reversed after the terminal reconnected past the grace window; the void is signalled in real time by the paymentVoided WebSocket notification.

Authorizations

x-api-key
string
header
required

HMAC-SHA256 authentication. Requires three headers: x-api-key (your API key), x-timestamp (ISO 8601 timestamp, within 5 minutes of server time), and x-signature (Base64-encoded HMAC-SHA256 signature). The string to sign is METHOD + "\n" + PATH + "\n" + TIMESTAMP + "\n" + SHA256(BODY). PATH is the endpoint path WITHOUT the /v1/terminal-gateway gateway prefix, for example /v1/terminals. SHA256(BODY) is the hex hash of the exact body you send. See the Authentication documentation.

Path Parameters

transactionId
string
required

The transaction ID to query

Response

Transaction details

transactionId
string
required

Unique transaction identifier

status
enum<string>
required

Transaction lifecycle status. The GET transaction endpoint serializes this in PascalCase (Rust Debug of the status), so branch on these exact values.

Available options:
Pending,
Completed,
Failed,
Cancelled,
AwaitingReconnect,
Voided
request
object
required
createdAt
string<date-time>
required

ISO 8601 timestamp of creation

updatedAt
string<date-time>
required

ISO 8601 timestamp of last update

timestamp
string<date-time>
required

ISO 8601 timestamp of this response

response
object
completedAt
string<date-time>

ISO 8601 timestamp of completion