Skip to main content
GET
/
v1
/
balance_transactions
List Balance Transactions
curl --request GET \
  --url https://api.withflex.com/v1/balance_transactions \
  --header 'Authorization: Bearer <token>'
{
  "balance_transactions": [
    {
      "balance_transaction_id": "<string>",
      "amount": 123,
      "fee": 123,
      "net": 123,
      "status": "available",
      "test_mode": true,
      "available_on": "<string>",
      "created_at": "<string>",
      "exchange_rate": 123,
      "reporting_category": "<string>",
      "checkout_session_id": "<string>",
      "client_reference_id": "<string>",
      "source_id": "<string>",
      "type": "<string>",
      "flex_payment_intent_id": "<string>",
      "mid": "<string>",
      "currency": "<string>",
      "metadata": {},
      "transaction_fee_amount": 123,
      "interchange_fee_amount": 123,
      "lmn_fee_amount": 123,
      "dispute_fee_amount": 123,
      "card_type": "<string>",
      "card_network": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
balance_transaction_id
string | null
​
payout_id
string | null
​
reporting_category
string | null

Filter by reporting category (e.g., charge, refund, dispute, payout).

​
type
string | null

Filter by transaction type (e.g., payment, payment_refund, adjustment, payout).

​
starting_after
string | null

A cursor for use in pagination. starting_after is a balance transaction ID that defines your place in the list. For instance, if you make a list request and receive 20 balance transactions, ending with fbt_xyz, your subsequent call can include starting_after=fbt_xyz to fetch the next page.

​
ending_before
string | null

A cursor for use in pagination. ending_before is a balance transaction ID that defines your place in the list. For instance, if you make a list request and receive 20 balance transactions, starting with fbt_abc, your subsequent call can include ending_before=fbt_abc to fetch the previous page.

​
limit
integer<int32> | null
Required range: x >= 1

Response

​
balance_transactions
object[]
required