Transactions can be created using the POST /charge endpoint when processing payments.

Core Transaction Operations

List & Filter Transactions

Retrieve all transactions associated with a merchant account with query parameters to sort and filter transaction data.

Requirements: Authentication Token, Active Team, and Enabled Team

Get Transaction Details

Retrieve detailed information about a specific transaction using its unique ID, including payment method, customer details, and child transactions.

Requirements: Authentication Token, Active Team, and Enabled Team

Update Transaction

Update certain details of manually created transactions. Cannot be used for transactions created by Stax from invoices or POST /charge.

Requirements: Authentication Token, Active Team, and Enabled Team

Transaction Communication

Email Receipt

Send an email receipt for a transaction to the customer's email on file, with option to send copies to additional addresses.

Requirements: Authentication Token, Active Team, and Enabled Team

SMS Receipt

Send a transaction receipt via SMS to the customer. Feature must be enabled for your account.

Requirements: Authentication Token, Active Team, and Enabled Team

Void or Refund a Transaction

Handle transaction reversals based on current status:

Void: Cancels a transaction before it is batched, preventing fees. Only possible before settlement.
Refund: Returns funds after a transaction has been batched (settled). Partial refunds supported.

Key Points:

Requirements: Authentication Token, Active Team, and Enabled Team

Authentication Requirements

Ensure you have a valid Authentication Token, Active Team, and Enabled Team for all transaction-related operations.

Timing Considerations

Voids and Refunds Timing

Settlement Tokenization

Transaction Modifications

Updating Transactions

Exercise caution when updating transaction data, especially within the meta object
Modifications may affect receipts, invoices, and integrations like QuickBooks Online
Only manually created transactions can be updated

Partial Operations

Error Handling & Testing

Error Handling Implement robust error handling to capture:

Testing Environment