transactions/ endpoint provides an interface for retrieving and managing payment information from the shop system.
For each transaction you can view details such as the payment method, status, amounts and timing. In addition, the interface supports updating the status as well as actions such as capture, refund or cancellation.
Supported methods
List of all supported methods.Data fields of a transaction
Example
Methods for transactions
The following methods let you manage transactions in the shop system. A transaction records the payment movement for an order and contains information such as amount, status, payment method and times of payment or refund. Through the API, transactions can be read, their status updated, refunded, canceled or captured. For all methods, the corresponding permissions to read or write transaction data must be available.GET transactions
Thetransactions endpoint lets you access a list of completed transactions in the shop.
The API lets you filter and sort transactions by various criteria such as time ranges, payment status or subshop. Transactions contain information about amounts, payment methods, associated orders and customer accounts, among other things.
To access this endpoint, the corresponding permissions to read transaction data must be available.
Example
The example shows a query of up to 100 transactions created in the period from 2025-03-23 to 2025-04-22 inclusive.Response
Filter fields
id, createdAt, payedAt, refundedAt, paymentStatus, subshopId, accountId, sandboxPayment
Sort fields
id, createdAt, updatedAt, payedAt, refundedAt, paymentStatus, subshopId, accountId, orderId, sessionId, clearerId, currency, amount, paymentMethod, sandboxPayment
Error codes
GET transactions/{id}
This method loads the complete details of a single transaction based on its unique ID. You can use it to retrieve transaction information such as payment status, addresses and additional data. To use this method, the required permissions to read transactions must be available.Example
Response
Error codes
PUT transactions/{id}/refresh
This method queries the current status of an existing transaction with the connected payment service provider and updates it. It can be used when the status of a transaction no longer appears up to date (e.g. for pending payments or refunds). The corresponding permissions to write transaction data must be available.Example
Response
Error codes
PUT transactions/{id}/cancel
This method attempts to cancel a transaction with the connected payment service provider. This is required, for example, for payments that have not yet been completed or that contain errors. After a successful cancellation, the updated transaction is returned. The corresponding permissions to write transactions must be available.Example
Response
paymentStatus is usually set to 4 (Canceled) or 6 (CanceledByAdmin). The exact value depends on the payment service provider.
Error codes
PUT transactions/{id}/refund
This method triggers a refund of an already paid amount for the specified transaction. Optionally, a partial amount (amount) and a refund reason (reason) can be provided in the request body. If no amount is specified, the entire amount is refunded. After a successful refund, the updated transaction is returned.
For this action, the corresponding permissions to write transactions must be available.
Example
Request body
Response
paymentStatus is set to 7 (Refunded) or 8 (RefundedPartially), depending on whether the entire amount or a partial amount was refunded.
Error codes
PUT transactions/{id}/capture
This method is used to capture a reserved transaction, i.e. the amount that was only earmarked is finally debited from the customer account. This function is mainly needed for payment providers where authorization and a separate capture are required (e.g. credit card). The updated transaction is then returned. For this action, the corresponding permissions to write transactions must be available.Example
Response
paymentStatus is usually set to 1 (Finished). In case of an error it is set to 2 (Error).