Bank Transactions

The BankTransaction Object

Properties

idstring

The Rutter generated unique ID of the bank transaction.

platform_idstring

The platform specific ID of the bank transaction.

account_idstringnullable

The Rutter ID of the Bank Account linked to the bank transaction.

amountnumbernullable

The amount of the bank transaction.

currency_codeenumnullable

The ISO 4217 currency code of the bank transaction.

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, ZMW, ETH, BTC, or null.
datestringnullable

The ISO 8601 timestamp for when the bank transaction occurred.

merchant_namestringnullable

The name of the merchant associated with the bank transaction.

statusenumOptional

The status of the bank transaction.

One ofpending or posted.
categoryarray

An array of categories linked to the bank transaction. These values are not standardized and vary depending on the source data.

String array.

last_synced_atstring

The ISO 8601 timestamp when the bank transaction was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/banking/bank_transactions
GET
/banking/bank_transactions/:id

List Bank Transactions

GEThttps://production.rutterapi.com/versioned/banking/bank_transactions

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Currently supports the updated_at and last_synced_at fields.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

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

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_transactions": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "account_id": "00000000-0000-0000-0000-000000000000",


7
      "amount": 100,


8
      "currency_code": "USD",


9
      "date": "2023-01-02",


10
      "merchant_name": "Merchant Name",


11
      "status": "posted",


12
      "category": [


13
        "category1",


14
        "category2"


15
      ],


16
      "last_synced_at": "2023-01-02T02:34:56.000Z",


17
      "platform_data": {


18
        "id": 123,


19
        "data": "Varies by platform"


20
      }


21
    }


22
  ],


23
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


24
  "connection": {


25
    "id": "00000000-0000-0000-0000-000000000000",


26
    "orgId": "00000000-0000-0000-0000-000000000000",


27
    "platform": "NETSUITE"


28
  }


29
}

Fetch a Bank Transaction

GEThttps://production.rutterapi.com/versioned/banking/bank_transactions/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

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

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_transaction": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "account_id": "00000000-0000-0000-0000-000000000000",


6
    "amount": 100,


7
    "currency_code": "USD",


8
    "date": "2023-01-02",


9
    "merchant_name": "Merchant Name",


10
    "status": "posted",


11
    "category": [


12
      "category1",


13
      "category2"


14
    ],


15
    "last_synced_at": "2023-01-02T02:34:56.000Z",


16
    "platform_data": {


17
      "id": 123,


18
      "data": "Varies by platform"


19
    }


20
  },


21
  "connection": {


22
    "id": "00000000-0000-0000-0000-000000000000",


23
    "orgId": "00000000-0000-0000-0000-000000000000",


24
    "platform": "NETSUITE"


25
  }


26
}

Have questions?

Contact support for personalized guidance.

Contact support