Properties
| Name | Type | Description |
|---|---|---|
| balance | object | |
| connection | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/rutter/json-schema/rutter-get-balance-response-schema.json",
"title": "GetBalanceResponse",
"x-generated": "2026-11-05",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/rutter-payments-api-openapi.yml#/components/schemas/GetBalanceResponse",
"type": "object",
"properties": {
"balance": {
"anyOf": [
{
"$ref": "#/$defs/Balance"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/Balance"
}
}
]
},
"connection": {
"$ref": "#/$defs/Connection"
}
},
"required": [
"balance",
"connection"
],
"$defs": {
"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"
]
},
"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"
]
},
"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."
}
}
}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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/rutter-get-balance-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.
A second provider on the same verified email joins the account you already have.