Balance

The Balance Object

A Rutter Balance represents the current amount of money contained within the merchant's store or payment processor.

Properties

amountnumber

The current balance of the merchant.

iso_currency_codeenum

The ISO 4217 currency code of the balance.

One ofAED, 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, or ZMW.

platform_dataobjectOptional

Endpoints

GET

/balance

List Balance

GEThttps://production.rutterapi.com/versioned/balance

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

balance

connectionobject

Show connection attributes

Support by integration

Shopify
Amazon
Stripe
PayPal

Example Response Body

JSON

1{
2  "balance": {
3    "amount": 12.34,
4    "iso_currency_code": "USD"
5  },
6  "connection": {
7    "id": "00000000-0000-0000-0000-000000000000",
8    "orgId": "00000000-0000-0000-0000-000000000000",
9    "platform": "SHOPIFY"
10  }
11}

Have questions?

Contact support for personalized guidance.

Contact support