Skip to main content
GET
/
v1
/
balance_transactions
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/balance_transactions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "88f92d11-8370-4fb6-8993-a91e9aa2f5a7",
  "object": "balance_transaction",
  "amount": 2000,
  "currency": "usd",
  "ending_balance_amount": 0,
  "transaction_type": "adjustment",
  "balance": "5994e4a6-4eaf-4606-b686-cddc0bfa8f46",
  "customer": "46805c21-e20d-4574-a4fe-9d8446e18c63",
  "checkout": null,
  "created_at": 1780925352,
  "updated_at": 1780925352
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

amount
integer

The amount of the transaction. A negative value is a credit for the customer’s balance, and a positive value is a debit to the customer’s balance.

currency
string

Three-letter ISO currency code, in lowercase.

balance

Expandable – The associated balance ID.

customer

Expandable – The associated customer ID.

ending_balance_amount
integer

The balance amount after the transaction was applied.

checkout

Expandable – The associated checkout ID.

transaction_type
string

One of either adjustment, applied_to_checkout, checkout_below_currency_minimum, or checkout_credit. Balance transactions created through the API are always adjustment transactions.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.