Skip to main content
Version: Lab (preview)

availableFundsBalance

QUERY

This query returns the instructional hold and reserve balances for a merchant, along with the instruction window status.

Arguments

merchant_uidRequired
ID
The Pay Theory unique identifier assigned to the merchant.

Response

ArrayAvailableFundsBalance
instructional_hold_balance
String
Available funds held for instructional funding, in cents as a 64-bit string.
reserve_balance
String
Reserve balance for the merchant, in cents as a 64-bit string.
instruction_window_status
WindowStatus
The current instruction window status.
Values
OPENCLOSED
instructional_hold_balance_updated
Boolean
Whether the latest instructional hold balance update has been applied.