List Balance Transactions - Flex Documentation

List Balance Transactions

cURL

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

Python

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript (Fetch)

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

<?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;
}
?>

Go

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))
}

Unirest (Java)

HttpResponse<String> response = Unirest.get("https://api.withflex.com/v1/balance_transactions")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

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

Status Codes

• 200
• 401
• 403
• 404
• 409
• 422
• 429

Response Structure

{
  "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"
      }
    }
  ]
}

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)
• payout_id: string | null (Filter by payout ID to see transactions included in a specific payout)
• 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)
• source_id: string | null (Filter by Flex source ID)
• starting_after: string | null (A cursor for pagination)
• ending_before: string | null (A cursor for pagination)
• limit: integer | null (Limit on the number of objects to be returned, range: x >= 1)

Response Example

200 - application/json

An envelope wrapping a list of balance transaction objects:

{
  "balance_transactions": []
}