Rutter

Rutter Transactions API

The Transactions API from Rutter — 2 operation(s) for transactions.

GitHub OpenAPI

Operations 2

GET /transactions List commerce transactions #
GET /transactions/{id} Fetch commerce transaction #

Documentation

📖
Documentation
https://docs.rutter.com/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rutter/openapi/rutter-transactions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-transactions-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-balance-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-subscriptions-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-payouts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-transactions-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-payouts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-webhook-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-webhook-logs-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-webhook-log-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-request-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-json-path-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-update-json-path-config-response-schema.json

Other Resources

🔗
ProductPage
https://www.rutter.com/product/payments-api

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/rutter:rutter-transactions-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

rutter-transactions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rutter Transactions API
  version: '2024-08-31'
  description: The Universal API for all major e-commerce platforms, accounting systems, and payment processors.
servers:
- url: https://production.rutterapi.com/versioned
  description: Production server
- url: https://sandbox.rutterapi.com/versioned
  description: Sandbox server
tags:
- name: Transactions
paths:
  /transactions:
    get:
      summary: List commerce transactions
      operationId: listCommerceTransactions
      parameters:
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/access_token'
      - name: cursor
        in: query
        required: false
        description: Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/cursor'
      - name: limit
        in: query
        required: false
        description: Used to limit the number of returned objects. Defaults to 50.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/limit'
      - name: sort
        in: query
        required: false
        description: Order of transactions returned. Defaults to `desc` (most recent first).
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/sort'
      - name: expand
        in: query
        required: false
        description: Include platform specific data (includes additional fields not provided by the Rutter object).
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/expand'
      - name: created_at_max
        in: query
        required: false
        description: Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/created_at_max'
      - name: created_at_min
        in: query
        required: false
        description: Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/created_at_min'
      - name: updated_at_max
        in: query
        required: false
        description: Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/updated_at_max'
      - name: updated_at_min
        in: query
        required: false
        description: Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/updated_at_min'
      - name: force_fetch
        in: query
        required: false
        description: Used to force a response even if the underlying connection has not finished its initial sync.
        schema:
          $ref: '#/components/schemas/ListTransactionsQuery/properties/force_fetch'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionsResponse'
              examples:
                ListTransactionsResponse_Example:
                  $ref: '#/components/examples/ListTransactionsResponse_Example'
      x-supported-platforms:
      - AMAZON
      - CHARGEBEE
      - CHARGIFY
      - CLOVER
      - EBAY
      - ETSY
      - LAZADA
      - MAGENTO
      - MERCADOLIBRE
      - MOLLIE
      - PAYPAL
      - PRESTASHOP
      - RECHARGE
      - SHOPIFY
      - SQUARE
      - STRIPE
      - WALMART
      - WOO_COMMERCE
      x-sandbox-supported-platforms: []
      tags:
      - Transactions
      x-summary-source: derived
  /transactions/{id}:
    get:
      summary: Fetch commerce transaction
      operationId: fetchCommerceTransaction
      parameters:
      - name: id
        in: path
        required: true
        description: The Rutter generated unique ID of the object.
        schema:
          $ref: '#/components/schemas/RutterIdPathParams/properties/id'
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/CommonGetParamsWithExpand/properties/access_token'
      - name: expand
        in: query
        required: false
        description: Include platform specific data (includes additional fields not provided by the Rutter object).
        schema:
          $ref: '#/components/schemas/CommonGetParamsWithExpand/properties/expand'
      - name: force_fetch
        in: query
        required: false
        description: Used to force a response even if the underlying connection has not finished its initial sync.
        schema:
          $ref: '#/components/schemas/CommonGetParamsWithExpand/properties/force_fetch'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionsResponse'
              examples:
                GetTransactionsResponse_Example:
                  $ref: '#/components/examples/GetTransactionsResponse_Example'
      x-supported-platforms:
      - PAYPAL
      - SHOPIFY
      x-sandbox-supported-platforms: []
      tags:
      - Transactions
      x-summary-source: derived
components:
  schemas:
    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
      examples:
      - OrderTransaction_Example:
          $ref: '#/components/examples/OrderTransaction_Example'
    RutterIdPathParams:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The Rutter generated unique ID of the object.
      required:
      - id
    ListTransactionsQuery:
      type: object
      properties:
        access_token:
          type: string
          format: uuid
          description: The access token of the connection.
        cursor:
          type: string
          description: Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.
        limit:
          type: integer
          description: Used to limit the number of returned objects. Defaults to 50.
        sort:
          type: string
          enum:
          - desc
          - asc
          description: Order of transactions returned. Defaults to `desc` (most recent first).
        expand:
          type: array
          items:
            type: string
            enum:
            - platform_data
          description: Include platform specific data (includes additional fields not provided by the Rutter object).
        created_at_max:
          type: integer
          description: Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        created_at_min:
          type: integer
          description: Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        updated_at_max:
          type: integer
          description: Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        updated_at_min:
          type: integer
          description: Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        force_fetch:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Used to force a response even if the underlying connection has not finished its initial sync.
      required:
      - access_token
    ListTransactionsResponse:
      type: object
      properties:
        transactions:
          $ref: '#/components/schemas/Transactions'
        next_cursor:
          type:
          - string
          - 'null'
        connection:
          $ref: '#/components/schemas/Connection'
      required:
      - transactions
      - next_cursor
      - connection
      examples:
      - ListTransactionsResponse_Example:
          $ref: '#/components/examples/ListTransactionsResponse_Example'
    Transaction:
      type: array
      items:
        $ref: '#/components/schemas/OrderTransaction'
    CommonGetParamsWithExpand:
      type: object
      properties:
        access_token:
          type: string
          format: uuid
          description: The access token of the connection.
        expand:
          type: array
          items:
            type: string
            enum:
            - platform_data
          description: Include platform specific data (includes additional fields not provided by the Rutter object).
        force_fetch:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Used to force a response even if the underlying connection has not finished its initial sync.
      required:
      - access_token
    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: '#/components/schemas/Platform'
      required:
      - id
      - orgId
      - platform
      examples:
      - Connection_Example:
          $ref: '#/components/examples/Connection_Example'
    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.
    GetTransactionsResponse:
      type: object
      properties:
        transaction:
          $ref: '#/components/schemas/Transaction'
        connection:
          $ref: '#/components/schemas/Connection'
      required:
      - transaction
      - connection
      examples:
      - GetTransactionsResponse_Example:
          $ref: '#/components/examples/GetTransactionsResponse_Example'
    Transactions:
      type: array
      items:
        $ref: '#/components/schemas/OrderTransaction'
  examples:
    OrderTransaction_Example:
      value:
        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
    GetTransactionsResponse_Example:
      value:
        transaction:
        - 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
        connection:
          id: 00000000-0000-0000-0000-000000000000
          orgId: 00000000-0000-0000-0000-000000000000
          platform: SHOPIFY
    ListTransactionsResponse_Example:
      value:
        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=
        connection:
          id: 00000000-0000-0000-0000-000000000000
          orgId: 00000000-0000-0000-0000-000000000000
          platform: SHOPIFY
    Connection_Example:
      value:
        id: 00000000-0000-0000-0000-000000000000
        orgId: 00000000-0000-0000-0000-000000000000
        platform: SHOPIFY