Rutter · Schema

GetTransactionsResponse

AccountingB2BCommerceFinancial DataPaymentsUnified APIHRIS

Properties

Name Type Description
transaction object
connection object
View JSON Schema on GitHub

JSON Schema

rutter-get-transactions-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/rutter/json-schema/rutter-get-transactions-response-schema.json",
  "title": "GetTransactionsResponse",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rutter-payments-api-openapi.yml#/components/schemas/GetTransactionsResponse",
  "type": "object",
  "properties": {
    "transaction": {
      "$ref": "#/$defs/Transaction"
    },
    "connection": {
      "$ref": "#/$defs/Connection"
    }
  },
  "required": [
    "transaction",
    "connection"
  ],
  "$defs": {
    "Connection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The UUID of the connection. Generated by Rutter."
        },
        "orgId": {
          "type": "string",
          "format": "uuid",
          "description": "Your organization id."
        },
        "platform": {
          "$ref": "#/$defs/Platform"
        }
      },
      "required": [
        "id",
        "orgId",
        "platform"
      ]
    },
    "OrderTransaction": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The Rutter generated unique ID of the transaction.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "CLOVER": {},
            "MOLLIE": {},
            "PAYNL": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "platform_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The platform specific ID of the transaction.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "CLOVER": {},
            "MOLLIE": {},
            "PAYNL": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "order_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Rutter ID of the [Order](/rest/version/orders) linked to the transaction.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "SHOPIFY": {},
            "WALMART": {}
          }
        },
        "platform_customer_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The platform specific ID of the customer linked to the transaction.",
          "x-rutter-platforms": {
            "RECHARGE": {},
            "STRIPE": {}
          }
        },
        "payment_method_type": {
          "type": "string",
          "enum": [
            "cash",
            "card",
            "other"
          ],
          "description": "The payment method associated with the transaction. Some enum value clarifications:\n  - `cash` - this type will mainly appear on self-hosted platforms like WooCommerce where Cash on Delivery is available.\n  - `card` - includes credit or debit card payments",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "CLOVER": {},
            "MOLLIE": {},
            "PAYNL": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "success",
            "failure",
            "pending",
            "cancelled",
            "refunded",
            "other"
          ],
          "description": "The status of the transaction.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "CLOVER": {},
            "MOLLIE": {},
            "PAYNL": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "type": {
          "type": "string",
          "enum": [
            "sale",
            "refund",
            "void",
            "payout",
            "fee",
            "chargeback",
            "chargeback_reversal",
            "other"
          ],
          "description": "The transaction type associated with the transaction. Some enum value clarifications:\n  - `void` - means a cancellation of a pending transaction.\n  - `payout` - means the merchant transferred the money held in the platform to the merchant's own bank account.\n  - `chargeback` - a dispute withdrawal from the merchant.\n  - `chargeback_reversal` - funds returned to the merchant after a chargeback is won or released.\n  - `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.\n\n  The chargeback transaction types are rolling out behind platform feature flags. To avoid changing existing integrations' transaction type results, these values are only returned for connections where the rollout is enabled.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "CLOVER": {},
            "MOLLIE": {},
            "PAYNL": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "amount": {
          "type": [
            "number",
            "null"
          ],
          "description": "The amount associated with the transaction.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "CLOVER": {},
            "MOLLIE": {},
            "PAYNL": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "fee": {
          "type": "number",
          "description": "The fee associated with the transaction.",
          "x-rutter-platforms": {
            "RECHARGE": {},
            "SHEIN": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "gateway": {
          "type": [
            "string",
            "null"
          ],
          "description": "The gateway associated with the transaction.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "RECHARGE": {},
            "SHOPIFY": {},
            "STRIPE": {}
          }
        },
        "gateway_data": {
          "description": "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.",
          "type": [
            "null"
          ],
          "x-rutter-platforms": {
            "AMAZON": {},
            "SHOPIFY": {},
            "STRIPE": {}
          }
        },
        "iso_currency_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the transaction.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "MOLLIE": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "platform_type": {
          "type": "string",
          "description": "The platform type associated with the transaction.",
          "x-rutter-platforms": {
            "RECHARGE": {},
            "SHEIN": {},
            "WALMART": {}
          }
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The description of the transaction",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "SHEIN": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "created_at": {
          "type": "string",
          "description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the transaction was created.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "AUTHORIZENET": {},
            "CLOVER": {},
            "MOLLIE": {},
            "PAYNL": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "updated_at": {
          "type": "string",
          "description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the transaction was last updated.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "CLOVER": {},
            "RECHARGE": {},
            "SHEIN": {},
            "SHOPIFY": {},
            "STRIPE": {},
            "WALMART": {}
          }
        },
        "platform_data": {
          "type": "object",
          "additionalProperties": {},
          "description": "The raw platform data corresponding to the Rutter object.",
          "x-rutter-platforms": {
            "AMAZON": {},
            "SHEIN": {},
            "STRIPE": {}
          }
        }
      },
      "required": [
        "id",
        "order_id",
        "payment_method_type",
        "status",
        "type",
        "amount",
        "gateway",
        "iso_currency_code",
        "created_at",
        "updated_at"
      ]
    },
    "Platform": {
      "type": "string",
      "enum": [
        "AMAZON",
        "EBAY",
        "ETSY",
        "FNAC",
        "WALMART",
        "SHOPEE",
        "LAZADA",
        "MERCADOLIBRE",
        "ALIBABA",
        "WAYFAIR",
        "SHEIN",
        "NOON",
        "SHOPLINE",
        "PRESTASHOP",
        "SHOPIFY",
        "MAGENTO",
        "WOO_COMMERCE",
        "SQUARESPACE",
        "WIX",
        "SHOPER",
        "SHOPLAZZA",
        "BIG_COMMERCE",
        "SALLA",
        "ZID",
        "TIKTOKSHOP",
        "COMMERCELAYER",
        "WEBFLOW",
        "GUMROAD",
        "ECWID",
        "PAYPAL",
        "SQUARE",
        "STRIPE",
        "CLOVER",
        "MOLLIE",
        "PAYNL",
        "AUTHORIZENET",
        "RECHARGE",
        "CHARGIFY",
        "CHARGEBEE",
        "RECURLY",
        "KASHFLOW",
        "SAGE_INTACCT",
        "SAGE_INTACCT_V2",
        "DYNAMICS365",
        "DYNAMICS365FO",
        "ZOHOBOOKS",
        "EXACTONLINE",
        "FREEAGENT",
        "QUICKBOOKS",
        "QUICKBOOKS_DESKTOP",
        "FRESHBOOKS",
        "XERO",
        "SAGE_BUSINESS_CLOUD",
        "SAGE_50",
        "VISTA",
        "NETSUITE",
        "WAVE",
        "DUALENTRY",
        "CAMPFIRE",
        "RILLET",
        "SOFTLEDGER",
        "VISMA",
        "SPIRIS",
        "LEXWARE",
        "MONEYBIRD",
        "SAGE200CLOUD",
        "MX",
        "PLAID",
        "TELLER",
        "RAMP",
        "ODOO",
        "ACUMATICA",
        "FULFIL",
        "TALLY",
        "SAPBUSINESSONE",
        "SAPS4HANA",
        "WORKDAY",
        "ANFIX",
        "ORACLEFUSION",
        "HOLDED",
        "MYOBBUSINESS",
        "FORTNOX",
        "GOOGLE",
        "FACEBOOK",
        "TIKTOK",
        "INTUIT_BANK_FEEDS",
        "PLAID_BANK_FEEDS",
        "SAGE",
        "SAGE_BANK_FEEDS",
        "YODLEE_BANK_FEEDS",
        "QUICKBOOKS_HRIS",
        "BAMBOO_HR",
        "GUSTO",
        "DEEL",
        "RIPPLING"
      ],
      "description": "The underlying platform."
    },
    "Transaction": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OrderTransaction"
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/rutter-get-transactions-response"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.