Commerce

Transactions
Get API Keys

The OrderTransaction object

A Rutter Transaction represents any money movement related to the merchant's store, including charges, refunds, payouts, chargebacks, etc.

Properties

idstring

The Rutter generated unique ID of the transaction.

platform_idstringnullableoptional

The platform specific ID of the transaction.

order_idstringnullable

The Rutter ID of the Order linked to the transaction.

platform_customer_idstringnullableoptional

The platform specific ID of the customer linked to the transaction.

payment_method_typeenum

The payment method associated with the transaction. Some enum value clarifications:

  • 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
One ofcash, card, or other.
statusenum

The status of the transaction.

One ofsuccess, failure, pending, cancelled, refunded, or other.
typeenum

The transaction type associated with the transaction. Some enum value clarifications:

  • 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.
One ofsale, refund, void, payout, fee, or other.
amountnumbernullable

The amount associated with the transaction.

feenumberoptional

The fee associated with the transaction.

gatewaystringnullable

The gateway associated with the transaction.

gateway_datanullableoptional

The gateway data associated with the transaction. An 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.

iso_currency_codestringnullable

The ISO 4217 currency code of the transaction.

platform_typestringoptional

The platform type associated with the transaction.

descriptionstringnullableoptional

The description of the transaction

created_atstring

The ISO 8601 timestamp that the transaction was created.

updated_atstring

The ISO 8601 timestamp that the transaction was last updated.

platform_dataobjectoptional
Show platform_data attributes
Example OrderTransaction Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "order_id": "00000000-0000-0000-0000-000000000000",
  "platform_customer_id": "12345678",
  "payment_method_type": "card",
  "status": "success",
  "type": "sale",
  "amount": 12.34,
  "fee": 1,
  "gateway": "bank_account",
  "gateway_data": "123456789",
  "iso_currency_code": "USD",
  "platform_type": "card",
  "description": "For order 1234",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Transactions

GET /transactions
Supported for: AmazonChargebeeChargifyEbayLazadaMagentoMercado LibrePayPalPrestaShopShopifySquareStripeWooCommerce

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    created_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum created_at datetime to fetch entities from.

    created_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum created_at datetime to fetch entities from.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    sortenumoptionalquery
    One ofdesc or asc.
    updated_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.

Response Body

    connectionobject
    Show connection attributes
    transactionsarray
    Show transactions attributes
    next_cursorstringnullable
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY"
  },
  "transactions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "order_id": "00000000-0000-0000-0000-000000000000",
      "platform_customer_id": "12345678",
      "payment_method_type": "card",
      "status": "success",
      "type": "sale",
      "amount": 12.34,
      "fee": 1,
      "gateway": "bank_account",
      "gateway_data": "123456789",
      "iso_currency_code": "USD",
      "platform_type": "card",
      "description": "For order 1234",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Next
Balance