Balances

List Transactions

Returns a keyset-paginated feed of balance transactions — one row per settled money event (invoice payment, payout, refund, recovery, conversion). Each row carries the gross amount, total fee, and net amount for the event. Page forward by passing the previous response's next_cursor back as cursor.

GET
/v1/transactions
X-API-Key<token>

API key issued by the merchant dashboard. The key's environment (live/test) determines which data the caller can access. Permissions on the key control which endpoints are reachable.

In: header

Query Parameters

kind?string

Filter by operation kind (invoice_payment, payout, refund, recovery, conversion, gas_topup, treasury_rebalance).

Lengthlength <= 64
money_status?string

Filter by money status (pending, posted, reversed).

Lengthlength <= 32
currency?string

Filter by currency code.

Lengthlength <= 20
from?string

Start of date range (RFC 3339).

Formatdate-time
to?string

End of date range (RFC 3339).

Formatdate-time
limit?integer

Maximum number of items to return (default 50, max 200).

Default50
Range1 <= value <= 200
cursor?string

Opaque keyset cursor from a previous response's next_cursor. Omit for the first page.

Lengthlength <= 200

Response Body

fetch("https://dashboard.halfin.xyz/api/v1/transactions?kind=string&money_status=string&currency=string&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&limit=50&cursor=string", {  method: "GET"})
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kind": "string",
      "money_status": "string",
      "environment": "live",
      "source_type": "string",
      "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
      "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
      "currency": "string",
      "gross_amount": "string",
      "fee_total": "string",
      "net_amount": "string",
      "counter_currency": "string",
      "counter_amount": "string",
      "rate": "string",
      "amount_usd": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "request_id": "string",
    "next_cursor": "string"
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ]
  },
  "meta": {
    "request_id": "string"
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ]
  },
  "meta": {
    "request_id": "string"
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ]
  },
  "meta": {
    "request_id": "string"
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ]
  },
  "meta": {
    "request_id": "string"
  }
}