Balance
The Balance Object
A Rutter Balance represents the current amount of money contained within the merchant's store or payment processor.
Properties
amount
numberThe current balance of the merchant.
iso_currency_code
enumThe 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_data
objectOptionalEndpoints
GET
/balance
List Balance
GEThttps://production.rutterapi.com/versioned/balance
Request Parameters
access_token
stringqueryThe access token of the connection.
force_fetch
enumqueryOptionalForce a response even if the underlying connection hasn't finished the initial sync.
One oftrue or false.
Response Body
connection
objectShow
connection
attributesbalance
Support by integration
- Shopify
- Amazon
- Stripe
- Paypal
Example Response Body
JSON
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "SHOPIFY"
6 },
7 "balance": {
8 "amount": 12.34,
9 "iso_currency_code": "USD"
10 }
11}
Have questions?
Contact support for personalized guidance.