Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rillet Bank Transactions API

The Bank Transactions API from Rillet — 2 operation(s) for bank transactions.

Rillet Bank Transactions API is one of 28 APIs that Rillet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bank Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version v4.0.

Requests are made against 2 base URLs: https://api.rillet.com, https://sandbox.api.rillet.com.

5 operations 2 paths 10 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v4.0
Base URL
https://api.rillet.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Rillet Bank Transactions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Bank Transactions 5
GET
/bank-transactions
Lists all bank transactions
list-all-bank-transactions 8 params → 200default
POST
/bank-transactions
Creates a bank transaction
create-a-bank-transaction body → 200default
GET
/bank-transactions/{bank_transaction_id}
Retrieves a bank transaction
retrieve-a-bank-transaction 1 param → 200default
PUT
/bank-transactions/{bank_transaction_id}
Updates a bank transaction
update-a-bank-transaction 1 param body → 200default
DELETE
/bank-transactions/{bank_transaction_id}
Deletes a bank transaction
delete-a-bank-transaction 1 param → 204default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are BankTransaction (11 properties), CreateBankTransactionRequest (9 properties), UpdateBankTransactionRequest (8 properties), Error (4 properties). Each schema is shown below with its type and property counts.

BankTransaction
object
11 properties 10 required
Error
object
4 properties 2 required
UpdateBankTransactionRequest
object
8 properties 5 required
PageCursor
string
If defined, a cursor to retrieve the next page.
PageLimit
integer
CreateBankTransactionRequest
object
9 properties 5 required
RoundedMonetaryAmount
object
A monetary amount that must be rounded to the currency's default decimal places (e.g., 2 decimal places for USD).
2 properties 2 required
Pagination
object
1 property
ExternalReference
object
For requests, only pre-defined custom IDs are accepted. In responses, an object imported through an integration (e.g. Stripe) would return the provider's objec…
3 properties 2 required
CurrencyCode
string
Currency code following ISO-4217

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rillet-bank-transactions-api-openapi.yml Raw ↑

Other APIs Rillet publishes across the network.

Rillet API Key API
Rillet Bank accounts API
Rillet Bill Payments API
Rillet Bills API
Rillet Books periods API
Rillet Charges API
Rillet Chart of Accounts API
Rillet Contract Items API
Rillet Contracts API
Rillet Credit Memos API
Rillet Customer Payments API
Rillet Customers API