Rutter

Rutter Balance API

The Balance API from Rutter — 1 operation(s) for balance.

GitHub OpenAPI

Operations 1

GET /balance List commerce balances #

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rutter/openapi/rutter-balance-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-balance-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-balance-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rutter Balance 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: Balance
paths:
  /balance:
    get:
      summary: List commerce balances
      operationId: listCommerceBalances
      parameters:
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/GetBalanceQueryParams/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/GetBalanceQueryParams/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/GetBalanceQueryParams/properties/force_fetch'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBalanceResponse'
              examples:
                GetBalanceResponse_Example:
                  $ref: '#/components/examples/GetBalanceResponse_Example'
      x-supported-platforms:
      - AMAZON
      - MOLLIE
      - PAYPAL
      - SHOPIFY
      - STRIPE
      x-sandbox-supported-platforms: []
      tags:
      - Balance
      x-summary-source: derived
components:
  schemas:
    Balance:
      type: object
      properties:
        amount:
          type: number
          description: The current balance of the merchant.
        iso_currency_code:
          type: string
          enum:
          - AED
          - AFN
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AUD
          - AWG
          - AZN
          - BAM
          - BBD
          - BDT
          - BGN
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BOV
          - BRL
          - BSD
          - BTN
          - BWP
          - BYR
          - BZD
          - CAD
          - CDF
          - CHE
          - CHF
          - CHW
          - CLF
          - CLP
          - CNY
          - COP
          - COU
          - CRC
          - CUC
          - CUP
          - CVE
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EGP
          - ERN
          - ETB
          - EUR
          - FJD
          - FKP
          - GBP
          - GEL
          - GHS
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HKD
          - HNL
          - HRK
          - HTG
          - HUF
          - IDR
          - ILS
          - INR
          - IQD
          - IRR
          - ISK
          - JMD
          - JOD
          - JPY
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGA
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MUR
          - MVR
          - MWK
          - MXN
          - MXV
          - MYR
          - MZN
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - NZD
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - RON
          - RSD
          - RUB
          - RWF
          - SAR
          - SBD
          - SCR
          - SDG
          - SEK
          - SGD
          - SHP
          - SLL
          - SOS
          - SRD
          - SSP
          - STD
          - SVC
          - SYP
          - SZL
          - THB
          - TJS
          - TMT
          - TND
          - TOP
          - TRY
          - TTD
          - TWD
          - TZS
          - UAH
          - UGX
          - USD
          - USN
          - USS
          - UYI
          - UYU
          - UYW
          - UZS
          - VEF
          - VND
          - VUV
          - WST
          - XAF
          - XAG
          - XAU
          - XBA
          - XBB
          - XBC
          - XBD
          - XCD
          - XDR
          - XFU
          - XOF
          - XPD
          - XPF
          - XPT
          - XTS
          - XXX
          - YER
          - ZAR
          - ZMW
          - ETH
          - BTC
          description: The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the balance.
        platform_data:
          type: object
          additionalProperties: {}
          description: The raw platform data corresponding to the Rutter object.
      required:
      - amount
      - iso_currency_code
      examples:
      - Balance_Example:
          $ref: '#/components/examples/Balance_Example'
    GetBalanceQueryParams:
      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.
    GetBalanceResponse:
      type: object
      properties:
        balance:
          anyOf:
          - $ref: '#/components/schemas/Balance'
          - type: array
            items:
              $ref: '#/components/schemas/Balance'
        connection:
          $ref: '#/components/schemas/Connection'
      required:
      - balance
      - connection
      examples:
      - GetBalanceResponse_Example:
          $ref: '#/components/examples/GetBalanceResponse_Example'
  examples:
    Balance_Example:
      value:
        amount: 12.34
        iso_currency_code: USD
    GetBalanceResponse_Example:
      value:
        balance:
          amount: 12.34
          iso_currency_code: USD
        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