GET
/
v1
/
financial-transactions
List Financial Transactions
curl --request GET \
  --url https://api.monime.io/v1/financial-transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": [
    {
      "id": "<string>",
      "type": "credit",
      "amount": {
        "currency": "<string>",
        "value": 123
      },
      "timestamp": "2023-11-07T05:31:56Z",
      "reference": "<string>",
      "financialAccount": {
        "id": "<string>",
        "balance": {
          "after": {
            "currency": "<string>",
            "value": 123
          }
        }
      },
      "originatingReversal": {
        "originTxnId": "<string>",
        "originTxnRef": "<string>"
      },
      "originatingFee": {
        "code": "<string>"
      },
      "ownershipGraph": {
        "owner": {
          "id": "<string>",
          "type": "<string>",
          "metadata": {},
          "owner": {
            "id": "<string>",
            "type": "<string>",
            "metadata": {},
            "owner": {}
          }
        }
      },
      "metadata": {}
    }
  ],
  "pagination": {
    "count": 123,
    "next": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Headers

Monime-Space-Id
string
required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum length: 64

Query Parameters

financialAccountId
string | null

Filter transactions involving the specified financial account ID.

reference
string | null

Filter by Monime-assigned transaction reference. Useful for retrieving all transactions grouped under the same reference identifier.

type
enum<string> | null

Filter transactions by type: 'credit' for incoming funds or 'debit' for outgoing ones.

Available options:
credit,
debit
limit
integer
default:10

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

Required range: 1 <= x <= 50
after
string | null

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Maximum length: 2000

Response

200 - application/json

OK

The response is of type object.