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.

Property

Type

Description

id

string

order_id

string | null

payment_method_type

string

One of:

  • cash
  • card
  • other

gateway

string

The name of the payment gateway the transaction was processed through.

gateway_metadata

object | null

An object containing additional metadata. The properties depend on the payment gateway used.

type

string

The transaction's type. One of:

  • sale
  • refund
  • void

amount

number

iso_currency_code

string

status

string

The transaction status. One of:

  • success
  • failure
  • pending

created_at

string

The ISO 8601 timestamp the transaction was created.