Balance transactions
Balance transactions are the itemized record of money added to or returned from your Inttegro balance. Each entry connects an amount to its order and payment or refund, giving finance and support teams a clear trail for reconciliation.
Use Balances to see current totals. Use balance transactions to explain those totals, trace money back to a sale or refund, and build exports for your accounting system.
The balance transaction object
Every balance transaction belongs to an order. A payment transaction includes its payment_id; a refund transaction includes its refund_id instead.
amount.value is always a non-negative value in the currency's smallest unit. Check type to determine whether the entry records a payment or a refund. Payout and lifecycle timestamps appear only after the corresponding event has happened.
Properties
Look up a balance transaction
Retrieve one balance transaction by its ID. Use this when you already have a bt_... identifier from an order, payout, dashboard, or previous list response and need the complete record.
Request attributes
Request
- cURL
- TypeScript
- Go
- Python
- PHP
- Ruby
- Java
- C#
curl https://api.inttegro.com/balance_transactions/lookup \
-H "Authorization: Bearer $INTTEGRO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"transaction_id": "bt_0123456789abcdefghijklmnopqrstuvwxyzABCD"
}'
import * as Inttegro from '@inttegro/inttegro-sdk'
const inttegro = new Inttegro.InttegroClient({
apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.balanceTransactions.lookup({
transactionId: "bt_0123456789abcdefghijklmnopqrstuvwxyzABCD",
})
package main
import (
"context"
"log"
"os"
inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)
func main() {
ctx := context.Background()
client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))
result, err := client.BalanceTransactions.Lookup(ctx, "bt_0123456789abcdefghijklmnopqrstuvwxyzABCD")
if err != nil {
log.Fatal(err)
}
_ = result
}
import os
import inttegro
client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.balance_transactions.lookup("bt_0123456789abcdefghijklmnopqrstuvwxyzABCD")
<?php
use Inttegro\Client;
$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->balanceTransactions->lookup("bt_0123456789abcdefghijklmnopqrstuvwxyzABCD");
require "inttegro"
client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.balance_transactions.lookup(transaction_id: "bt_0123456789abcdefghijklmnopqrstuvwxyzABCD")
import com.inttegro.Client;
public class Example {
public static void main(String[] args) throws Exception {
var client = new Client(System.getenv("INTTEGRO_API_KEY"));
var result = client.balanceTransactions().lookup("bt_0123456789abcdefghijklmnopqrstuvwxyzABCD");
}
}
using Inttegro;
using var inttegro = new InttegroClient(
Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.BalanceTransactions.LookupAsync("bt_0123456789abcdefghijklmnopqrstuvwxyzABCD");
Response
- Object
- JSON
TransactionResponse {
transaction: { … },
}
{
"transaction": {
"amount": { … },
"available_at": "2025-04-10T12:03:17.000Z",
"claimed_at": "2025-04-17T10:00:00.000Z",
"created_at": "2025-04-10T12:02:45.000Z",
"id": "bt_0123456789abcdefghijklmnopqrstuvwxyzABCD",
"order_id": "or_0123456789abcdefghijklmnopqrstuvwxyzABCD",
"payment_id": "py_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
"type": "payment"
}
}
Page through balance transactions
Browse balance activity from newest to oldest. Start with page 1, then request later pages until the response contains no transactions.
AI clients can use list_balance_transactions for this operation. MCP read tools return minimized business data and do not change Inttegro state.
Request attributes
Request
- cURL
- TypeScript
- Go
- Python
- PHP
- Ruby
- Java
- C#
curl https://api.inttegro.com/balance_transactions/page \
-H "Authorization: Bearer $INTTEGRO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"page_number": 1,
"page_size": 2
}'
import * as Inttegro from '@inttegro/inttegro-sdk'
const inttegro = new Inttegro.InttegroClient({
apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.balanceTransactions.page({
pageNumber: 1,
pageSize: 2,
})
package main
import (
"context"
"log"
"os"
inttegro "github.com/zebodotdev/inttegro-sdk-go/v4"
)
func main() {
ctx := context.Background()
client := inttegro.NewClient(os.Getenv("INTTEGRO_API_KEY"))
params := inttegro.BalanceTransactionPageParams{
PageNumber: 1,
PageSize: 2,
}
result, err := client.BalanceTransactions.Page(ctx, params)
if err != nil {
log.Fatal(err)
}
_ = result
}
import os
import inttegro
client = inttegro.InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
result = client.balance_transactions.page(inttegro.balance_transactions.PageRequest(
page_number=1,
page_size=2,
))
<?php
use Inttegro\Client;
$client = new Client($_ENV['INTTEGRO_API_KEY']);
$result = $client->balanceTransactions->page([
'page_number' => 1,
'page_size' => 2,
]);
require "inttegro"
client = Inttegro::Client.new(api_key: ENV.fetch("INTTEGRO_API_KEY"))
result = client.balance_transactions.page(
page_number: 1,
page_size: 2
)
import com.inttegro.Client;
import com.inttegro.balances.BalanceTransactionPageParams;
public class Example {
public static void main(String[] args) throws Exception {
var client = new Client(System.getenv("INTTEGRO_API_KEY"));
var params = BalanceTransactionPageParams.builder()
.pageNumber(1)
.pageSize(2)
.build();
var result = client.balanceTransactions().page(params);
}
}
using Inttegro;
using var inttegro = new InttegroClient(
Environment.GetEnvironmentVariable("INTTEGRO_API_KEY")!
);
var result = await inttegro.BalanceTransactions.PageAsync(new {
page_number = 1,
page_size = 2,
});