Skip to main content
GET
/
v1
/
transactions
/
{transactionId}
Get Transaction
curl --request GET \
  --url https://your-endpoint.moduluslabs.io/v1/transactions/{transactionId} \
  --header 'x-api-key: <api-key>'
{
  "transactionId": "TXN-20240115-001",
  "status": "COMPLETED",
  "request": {
    "transactionId": "TXN-20240115-001",
    "amount": "99.99",
    "currency": "USD",
    "paymentMethod": "CARD"
  },
  "response": {
    "transactionId": "TXN-20240115-001",
    "status": "SUCCESS",
    "amount": "99.99",
    "currency": "USD",
    "paymentMethod": "CARD",
    "authorizationCode": "AUTH123456",
    "timestamp": "2024-01-15T10:37:30.000Z"
  },
  "createdAt": "2024-01-15T10:37:00.000Z",
  "updatedAt": "2024-01-15T10:37:30.000Z",
  "completedAt": "2024-01-15T10:37:30.000Z",
  "timestamp": "2024-01-15T10:40:00.000Z"
}
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

StatusDescription
PENDINGTransaction created, awaiting terminal response
COMPLETEDTransaction completed successfully
FAILEDTransaction failed (check error details in response)
CANCELLEDTransaction was cancelled
AWAITING_RECONNECTTerminal disconnected mid-payment, waiting for reconnection
VOIDEDPayment was voided (terminal reconnected after grace period)

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
Check the voidedAt and voidReason fields for voided transactions.

Authorizations

x-api-key
string
header
required

HMAC-SHA256 authentication. Requires three headers: x-api-key (your API key), x-timestamp (ISO 8601 timestamp), and x-signature (Base64-encoded HMAC-SHA256 signature). See Authentication documentation for signature computation.

Path Parameters

transactionId
string
required

The transaction ID to query

Response

Transaction details

transactionId
string
required

Unique transaction identifier

status
enum<string>
required

Transaction status

Available options:
PENDING,
COMPLETED,
FAILED,
CANCELLED,
AWAITING_RECONNECT,
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

terminalDeviceId
string

Stable terminal device identifier

voidedAt
string<date-time>

ISO 8601 timestamp when payment was voided

voidReason
string

Reason for voiding the payment