List Balance Transactions

curl --request GET \
  --url https://api.withflex.com/v1/balance_transactions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.withflex.com/v1/balance_transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withflex.com/v1/balance_transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withflex.com/v1/balance_transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.withflex.com/v1/balance_transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
      "type": "string",
      "flex_payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "test_mode": false,
      "mid": "example_value",
      "currency": "usd",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "transaction_fee_amount": 0,
      "interchange_fee_amount": 0,
      "lmn_fee_amount": 0,
      "dispute_fee_amount": 0,
      "card_type": "string",
      "card_network": "string"
    }
  ]
}

{
  "code": "string",
  "detail": "string"
}

{
  "code": "string",
  "detail": "string"
}

{
  "code": "string",
  "detail": "string"
}

{
  "code": "string",
  "detail": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

{
  "code": "string",
  "detail": "string"
}

GET

balance_transactions

List Balance Transactions

curl --request GET \
  --url https://api.withflex.com/v1/balance_transactions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.withflex.com/v1/balance_transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withflex.com/v1/balance_transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withflex.com/v1/balance_transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.withflex.com/v1/balance_transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
      "type": "string",
      "flex_payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "test_mode": false,
      "mid": "example_value",
      "currency": "usd",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "transaction_fee_amount": 0,
      "interchange_fee_amount": 0,
      "lmn_fee_amount": 0,
      "dispute_fee_amount": 0,
      "card_type": "string",
      "card_network": "string"
    }
  ]
}

{
  "code": "string",
  "detail": "string"
}

{
  "code": "string",
  "detail": "string"
}

{
  "code": "string",
  "detail": "string"
}

{
  "code": "string",
  "detail": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

{
  "code": "string",
  "detail": "string"
}

Authorizations

Authorization

string

header

required

Use a Bearer token to access this API.

Query Parameters

balance_transaction_id

string | null

Filter by a specific balance transaction ID.

Example:

"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

payout_id

string | null

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

Example:

"fpo_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

reporting_category

string | null

Filter by reporting category.

type

string | null

Filter by transaction type.

flex_payment_intent_id

string | null

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

Example:

"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

source_id

string | null

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"

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.

Example:

"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

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.

Example:

"fbtxn_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

limit

integer<int32> | null

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

Required range: x >= 1

Example:

10

Response

An envelope wrapping a list of balance transaction objects.

balance_transactions

object[]

required

The list of balance transactions.

Show child attributes

⌘I

API Overview

API Reference

List Balance Transactions

Authorizations

Query Parameters

Response