API referenceTransactions

Everything that moved

One feed of every movement, newest first, paged exactly. Ordered and paged on `sequence`, a globally unique identity column, so no row is shown twice or skipped no matter what is written while somebody reads. The previous approach — merging `/charges` with `/payouts` on the client — could not offer that, because the two share no ordering. Readable by anybody who can see the business. A Viewer exists to look at the numbers, and a feed of what the business has done is the plainest form of that. 404 `NO_WALLET` when the business has no wallet: it has no book yet, which is a state to explain rather than an empty list that looks like no activity.

GET
/api/b/v1/transactions

One feed of every movement, newest first, paged exactly.

Ordered and paged on sequence, a globally unique identity column, so no row is shown twice or skipped no matter what is written while somebody reads. The previous approach — merging /charges with /payouts on the client — could not offer that, because the two share no ordering.

Readable by anybody who can see the business. A Viewer exists to look at the numbers, and a feed of what the business has done is the plainest form of that.

404 NO_WALLET when the business has no wallet: it has no book yet, which is a state to explain rather than an empty list that looks like no activity.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

currency?|null
entry_type?|

credit for money in, debit for money out.

reference_type?|

Narrow to one kind of movement.

since?|null
until?|null
before?|

The previous page's next_cursor. Omit for the newest page.

limit?Limit
Range1 <= value <= 200
Default50
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/transactions"
{  "transactions": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "sequence": 0,      "posting_id": "ec2c7a2a-2f1f-4893-b5c9-1169422c054f",      "entry_type": "credit",      "reference_type": "deposit",      "amount_minor": 0,      "balance_after_minor": 0,      "currency": "string",      "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",      "entry_metadata": {},      "occurred_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": 0}

What is worth knowing right now GET

Observations about this business's figures, most serious first. Each one is a named rule over data this API already returns — an overcommitted currency, failed payouts, movements waiting on a signature, open disputes, overdue invoices, a material change in flow, a material FX move on something actually held. An empty list means nothing fired, which is the common and correct answer for a business with nothing wrong. It should render as reassurance, not as a loading state.

List virtual accounts GET

Next Page