Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Balance Transactions

List Balance Transactions

Returns a list of Balance transactions.

get/v1/balance_transactions

Query parameters

balance_transaction_idstring nullable

Filter by a specific balance transaction ID.

Example:fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by a specific balance transaction ID.

payout_idstring nullable

Filter by payout ID to see transactions included in a specific payout.

Example:fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by payout ID to see transactions included in a specific payout.

reporting_categorystring nullable

Filter by reporting category.

Filter by reporting category.

typestring nullable

Filter by transaction type.

Filter by transaction type.

flex_payment_intent_idstring nullable

Filter by Flex payment intent ID. Returns balance transactions linked to that payment intent.

Example:fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by Flex payment intent ID. Returns balance transactions linked to that payment intent.

source_idstring nullable

Filter by Flex source ID. Returns balance transactions whose source object is the given Flex charge, refund, or payout (e.g., fch_…).

Example:obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by Flex source ID. Returns balance transactions whose source object is the given Flex charge, refund, or payout (e.g., fch_…).

starting_afterstring nullable

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.

Example:fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA

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_beforestring nullable

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.

Example:fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA

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.

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Response

An envelope wrapping a list of balance transaction objects.

Example response

{
  "balance_transactions": [
    {
      "balance_transaction_id": "fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "amount": 2500,
      "created_at": "2026-06-15T14:30:00Z",
      "exchange_rate": 1,
      "fee": 2500,
      "net": 2500,
      "reporting_category": "example_value",
      "checkout_session_id": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "status": "available",
      "source_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "flex_payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "test_mode": false,
      "mid": "example_value",
      "currency": "usd",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      }
    }
  ]
}
All 84 operations