Skip to main content
GET
Get account balance

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Path Parameters

id
string<uuid>
required

Account ID

Response

Account balance: total asset value, liabilities, and net position. In User-Funded projects and Program-Funded projects on Managed authorization, Reap authorizes each card transaction against these balances. Under External authorization this endpoint is not the authorization source: Reap holds no per-user asset balance, availableBalance reflects only Reap-side card debt and is not spendable, and your own ledger is authoritative.

currency
string
required

Currency for all monetary values - the billing currency of the project's card program

Examples:

"USD"

"HKD"

totalAssetValue
number
required

Sum of all asset values backing the account.

Required range: x >= 0
Example:

5000

totalLiabilities
number
required

Sum of all liabilities. Can be negative when refunds or settlement payments exceed outstanding card debt.

Examples:

500

0

-25

availableBalance
number
required

Net balance: totalAssetValue - totalLiabilities. In User-Funded projects and Program-Funded projects on Managed authorization, this is the spendable figure the next card swipe is authorized against and the primary number to surface to cardholders. Not a spendable figure under External authorization - see the endpoint description.

Example:

4500

assets
object
required

Breakdown of asset categories contributing to totalAssetValue

liabilities
object
required

Breakdown of liability categories contributing to totalLiabilities