Docs
API 2026-05-27.dahlia Dashboard

API reference

Balance transactions

Use with AI
View as MarkdownThe plain-text page agents read Open in ChatGPTStarts a chat that reads this page Open in ClaudeStarts a chat that reads this page

2 operations, with parameters and examples.

A balance transaction is one line of the store's statement: a charge, refund, dispute adjustment, payout or fee that moved the balance. A reserve hold or release moves the reserve: its balance_type is risk_reserved, and every other line's is payments. Every line that moves the store's balance is listed; one the store's own payments, refunds and payouts did not make is an adjustment, with its own reporting_category.

Send every request to https://api.fluveo.com/v1 with your secret key as a Bearer token. This page lists only what Fluveo serves; the OpenAPI file holds the same operations.

An operation or a parameter marked Preview works, but it is not locked yet and may change: what Preview means.

Lists balance transaction objects, newest first#

GET/v1/balance_transactionsrak_balance_read

Query parameters
  • createdobjectOptional

    Filter on the creation time, a Unix timestamp: created=<t> for an exact match, or created[gt], created[gte], created[lt], created[lte].

  • currencystringOptional

    Only balance transactions in this currency.

  • ending_beforestringOptionalPreview

    Cursor: the id of the first object of the current page, to get the previous page. Do not send it with starting_after.

  • limitintegerOptional

    How many objects to return, from 1 to 100. Default 10.

  • payoutstringOptional

    Only the balance transactions paid out in this payout (po_...).

  • sourcestringOptional

    Only the balance transactions of this object (ch_, re_, po_, ...). An id no line has gives an empty list.

  • starting_afterstringOptional

    Cursor: the id of the last object of the previous page, to get the next page. Do not send it with ending_before.

  • typestringOptional

    Only this kind of balance transaction, such as charge, refund or payout. A type no line has gives an empty list.

  • available_onobjectOptional

    Filter on the time the funds become available, a Unix timestamp: available_on=<t> for an exact match, or available_on[gt], available_on[gte], available_on[lt], available_on[lte].

Headers
  • Fluveo-VersionenumOptional

    Optional. The only version Fluveo serves is 2026-05-27.dahlia; any other value is refused with a 400. Every answer names that version in its own Fluveo-Version header, except the refusals Fluveo gives before it reads the request (no key, an unknown key, an unknown URL, a body that is not a form) and a file's bytes, which name no version and no Request-Id.

    One of: 2026-05-27.dahlia.

Returns a list of balance_transaction objects.

Request
curl -G https://api.fluveo.com/v1/balance_transactions \
  -H "Authorization: Bearer sk_test_..." \
  --data-urlencode "limit=5" \
  --data-urlencode "type=charge"
const response = await fetch("https://api.fluveo.com/v1/balance_transactions" + "?" + new URLSearchParams([["limit","5"],["type","charge"]]), {
  method: "GET",
  headers: {
    "Authorization": "Bearer sk_test_...",
  },
});
console.log(await response.json());
import requests

response = requests.get(
    "https://api.fluveo.com/v1/balance_transactions",
    headers={"Authorization": "Bearer sk_test_..."},
    params=[("limit", "5"), ("type", "charge")],
)
print(response.json())
<?php
$ch = curl_init("https://api.fluveo.com/v1/balance_transactions?limit=5&type=charge");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer sk_test_...",
    ],
]);
echo curl_exec($ch);

Retrieves a balance transaction#

GET/v1/balance_transactions/{id}rak_balance_read

Path parameters
  • idstringRequired

    The object's id.

Headers
  • Fluveo-VersionenumOptional

    Optional. The only version Fluveo serves is 2026-05-27.dahlia; any other value is refused with a 400. Every answer names that version in its own Fluveo-Version header, except the refusals Fluveo gives before it reads the request (no key, an unknown key, an unknown URL, a body that is not a form) and a file's bytes, which name no version and no Request-Id.

    One of: 2026-05-27.dahlia.

Returns a balance_transaction object.

Request
curl https://api.fluveo.com/v1/balance_transactions/txn_123 \
  -H "Authorization: Bearer sk_test_..."
const response = await fetch("https://api.fluveo.com/v1/balance_transactions/txn_123", {
  method: "GET",
  headers: {
    "Authorization": "Bearer sk_test_...",
  },
});
console.log(await response.json());
import requests

response = requests.get(
    "https://api.fluveo.com/v1/balance_transactions/txn_123",
    headers={"Authorization": "Bearer sk_test_..."},
)
print(response.json())
<?php
$ch = curl_init("https://api.fluveo.com/v1/balance_transactions/txn_123");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer sk_test_...",
    ],
]);
echo curl_exec($ch);

The balance_transaction object#

Ids start with txn_.

Attributes