Skip to main content
GET
/
v1
/
balance
/
transactions
/
{id}
Retrieve a balance transaction
curl --request GET \
  --url https://api.leanrails.com/v1/balance/transactions/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "btxn_xxx",
  "object": "balance_transaction",
  "amount": 123,
  "fee": 123,
  "net": 123,
  "currency": "<string>",
  "type": "<string>",
  "status": "available",
  "available_on": 123,
  "reporting_category": "<string>",
  "created": 123,
  "livemode": true,
  "description": "<string>",
  "source": "<string>",
  "exchange_rate": 123,
  "fee_details": [
    {}
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use your secret API key as the username with an empty password.

Headers

X-API-Version
string

Override the API version for this request.

Path Parameters

id
string
required

The balance transaction ID.

Response

The balance transaction.

id
string
required
Example:

"btxn_xxx"

object
enum<string>
required
Available options:
balance_transaction
amount
integer
required

Gross amount in smallest currency unit.

fee
integer
required

Total fee amount in smallest currency unit.

net
integer
required

Net amount in smallest currency unit.

currency
string
required

Three-letter ISO currency code.

type
string
required

Type of transaction (e.g. charge, refund, payout).

status
enum<string>
required

Whether the funds are available or still pending.

Available options:
available,
pending
available_on
integer
required

Unix timestamp when the funds become available.

reporting_category
string
required

Category for reporting purposes.

created
integer
required

Unix timestamp.

livemode
boolean
required
description
string | null
source
string | null

ID of the source object that caused this transaction.

exchange_rate
number | null

Exchange rate used if the transaction involved a currency conversion.

fee_details
object[]

Breakdown of fees.