Skip to navigation
AlphaX APITransactions

Get transaction by ID

View as Markdown

Get one transaction of the company by its ULID.

A card checkout payment comes back as a flat CheckoutPayment. Any other transaction is a Transaction: switch on type, then read data.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

transactionIdstringRequired

Response

Transaction details. A card checkout payment is returned as a CheckoutPayment; every other transaction is a Transaction (switch on type, then read data).

CheckoutPaymentobject
A card payment taken through checkout.
OR
Transactionobject

A discriminated union. Switch on type, then read data. Fields in data that do not apply are omitted.

Errors

403
Forbidden Error
404
Not Found Error