The Commerce Transactions object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Transactions endpoint, you can retrieve a list of all transactions for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier of the transaction. |
| orderId filterable | string | Order ID that this transaction is associated with. If the transaction is not associated with an order, or the platform doesn't support order type, this field would be null. |
| paymentMethodType sortable, filterable | string | Payment methods. |
| totalAmount filterable | decimal | The total amount for this transaction in its currency. This field should be negative for refunds. |
| currencyRef | Reference Types | Currency of the transaction. |
| transactionSourceRefs | Reference Types | Transactions, for example, a refund, include a transactionSourceRef, that contains the ID and type of the original transaction. |
| transactionType sortable, filterable | string | Transaction Types Status |
| createdDate sortable, filterable | string See Date | Date the transaction was created in the commerce platform. |
| sourceModifiedDate sortable, filterable | string See Date | Date the transaction was last updated in the commerce platform. |
| status sortable, filterable | string | The transaction status. |
Transaction Type Status
failedPayout- Failed transfer of funds from the seller's merchant account to their bank account.payment- Credit and debit card payments.paymentFee- Payment provider's fee on each card payment.paymentFeeRefund- Payment provider's fee that has been refunded to the seller.payout- Transfer of funds from the seller's merchant account to their bank account.refund- Refunds to a customer's credit or debit card.transfer- Secure transfer of funds to the seller's bank account.dispute- Transaction is a dispute.