v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
BalanceHistory

Retrieves a BalanceHistory resource.

Retrieves a BalanceHistory resource.

get/balance_histories/{id}

Path parameters

idstring required

Resource identifier

Response

BalanceHistory resource

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for balance history

amountinteger

The amount of the transaction

availableOnstring nullable

The date and time the transaction's net funds will be available in the account balance

createdstring

The date and time the transaction was created

currencystring

The currency the transaction was made in

balanceDescriptionstring nullable

A description of the transaction

exchangeRateinteger nullable

The exchange rate represented as a decimal

feeinteger nullable

The amount of fees paid for the transaction

feeTypestring nullable

The type of fee incurred e.g. "application fee"

netinteger

The net amount of the transaction after deducting all fees, tax and discounts

balanceStatusstring nullable

Whether the transaction is available in the account balance yet e.g. "available", "pending"

balanceTypestring nullable

The type of transaction e.g. "Charge" e.g. "Refund"

Example response

{
  "integration": "quickbooks"
}