List transactions, newest first

Cursor-paged: pass nextCursor back as cursor. There is no offset and no total.

GET /transactions

List transactions, newest first

cURL

curl --request GET \
  --url https://api.example.com/transactions \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "type": "<string>",
      "status": "pending",
      "isIncome": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
      "from": {
        "amount": "500.00",
        "currency": "<string>",
        "usdRate": "500.00"
      },
      "to": {
        "amount": "500.00",
        "currency": "<string>",
        "usdRate": "500.00"
      },
      "fee": {
        "amount": "500.00",
        "currency": "<string>",
        "usdRate": "500.00"
      },
      "counterparty": "<string>",
      "paymentReference": "<string>",
      "remitter": "<string>",
      "txHash": "<string>",
      "tag": "<string>",
      "hasAttachments": false
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Query Parameters

type · string | null

Comma-separated transaction types

status · string | null

Comma-separated statuses

tag · string | null

Comma-separated tags

contactId · string | null

bankId · string | null

incomeOnly · boolean | null

q · string | null

Minimum string length: 2

from · string<date-time> | null

to · string<date-time> | null

limit · integer · default: 50

Required range: 1 <= x <= 100

cursor · string | null

Maximum string length: 512

Response

200

application/json

Successful Response

items · TransactionView · object[] · required

Resources in this page, in stable server-defined order.

Show child attributes

nextCursor · string | null

Opaque cursor for the next page; absent when this is the final page.