Skip to main content
GET
Legacy Invoice Wallet Balance
Base URL: https://api.nozle.app/engine/api/v1. Get the legacy invoice wallet balance for a customer. Auth: secret key only. The key requires credit_system:read. Publishable keys are always rejected.
This is not a product Credit System balance. New integrations should use Customer Credit Balances.
string
required
External customer ID
Returns the customer’s active wallet, the most recently created one if there are several. A customer with no active wallet returns 404 with {"error": "no wallet found"}. Any other failure to read the wallet, such as a database error, also returns this 404.
string
required
Wallet identifier.
string
required
Wallet name. Empty string when the wallet has none.
number
required
Wallet balance in the smallest unit of currency. Check & Deduct lowers it with the credits it deducts.
string
required
Currency of the wallet.
string
required
Credits left, as a decimal string with five decimal places ("16.00000"). This is the live value: every Check & Deduct call changes it at once.
string
required
active for the wallet returned here.
A Check & Deduct call moves both balances. For example, a wallet funded with 20 credits at a rate of 1.00 shows balance_cents: 2000 and credits_balance: "20.00000"; after deducting 4 credits, credits_balance is "16.00000" and balance_cents is 1600.