Balance transactions

A Balance Transaction is an immutable merchant-ledger movement associated with a payment, payout, refund or other funds-moving resource. Use it to explain balance changes and fees. You cannot create or update these records directly.

API Endpoints

Retrieve a Balance Transaction: Fetches the details of a specific balance transaction by its ID.
List Balance Transactions: Returns a paginated list of balance transactions with optional filtering.
Retrieve Balance Transaction by Resource: Retrieves a transaction linked to a specific resource type and ID.

API Endpoint Reference

Method	Endpoint	Description
`GET`	`/api/v1/balance_transactions/:id`	Retrieve one transaction.
`GET`	`/api/v1/balance_transactions`	List account transactions; filter by chain or currency.
`GET`	`/api/v1/balance_transactions/resource`	Retrieve the transaction associated with a resource.

Attributes

Attribute	Type	Description
`id`	string	Unique identifier for the transaction.
`account_id`	string	ID of the associated account.
`balance_id`	string	ID of the associated balance.
`amount`	string	Transaction amount.
`currency`	string	Currency code of the transaction (e.g., `USDC`).
`chain`	string	Blockchain network of the transaction (e.g., `ethereum`).
`description`	string	Optional transaction description.
`fee`	string	Transaction fee.
`total`	string	Signed ledger total represented by the entry.
`fee_details`	array	Array of fee details.
`type`	string	Transaction type (e.g., `credit`).
`resource_type`	string	Type of associated resource (e.g., `payment_intent`).
`resource_id`	string	ID of associated resource (e.g., `pay_pdICAC1vp3WkAKof4QkM`).
`created_at`	string	Creation timestamp.
`updated_at`	string	Last update timestamp.

amount, fee, and total are decimal strings. Debit entries are returned with a leading minus sign on amount and total; still use type as the canonical ledger direction.

Balance transactions

API Endpoints

API Endpoint Reference

Attributes

On this page

Full Explorer