Transactions

The Transaction object

A Rutter Transaction represents any payment or attempted payment received by the merchant. Depending on the commerce platform connected, a Rutter Transaction may belong to an associated Rutter Order.

PropertyTypeDescription
idstringThe Rutter ID of the transaction. This value is a UUID generated by Rutter that uniquely identifies a transaction regardless of platforms.
order_idstring | nullThe Rutter 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
payment_method_typestringOne of:
- cash - this type will mainly appear on self-hosted platforms like WooCommerce where Cash on Delivery is available.
- card - includes credit or debit card payments
- other
gatewaystringThe name of the payment gateway the transaction was processed through.
gateway_dataobject | nullAn object containing additional metadata. This field is only populated for commerce platforms like Shopify that do their own payment processing & partner with another processor (Stripe), which attaches metadata to the transaction. Otherwise the value is null. The properties depend on the payment gateway used.
typestringThe transaction's type. One of:
- sale
- refund
- fee
- void - means a cancellation of a pending transaction.
- payout - means the merchant transferred the money held in the platform to the merchant's own bank account.
- other - If the transaction can't fit into any of the above types. This happens more often on self-hosted platforms where merchants create their own transaction types / have them in a different language.
amountfloatThe total amount for this transaction in its currency.
iso_currency_codestringThe ISO-4217 currency code of the transaction.
statusstringThe transaction status. One of:
- success
- failure
- pending
- cancelled
- refunded
- other
created_atstringThe ISO 8601 timestamp the transaction was created.