Retrieve the merchant's balance.

The amount response is the current merchant balance, which is the sum of all user purchases (use_balance transactions), minus any refunds and fees. This balance is considered revenue, and will be paid out according to the configured settlement schedule.

The promotionalAmount represents the available promotional balance to fund promotions, such as fund customer balance requests or a bonus amount configured for add balance requests. The promotionalAmount can go negative if promotions have been given out before the promotion has been funded. If multiple promotional accounts have been created, this promotionalAmount will only represent the default promotional account balance. To see the other promotional account balances, use the list promotional accounts endpoint.

The walletFundingHoldAmountrepresents the available balance used for fund wallet requests. The walletFundingHoldAmount can go negative in cases where the fund wallet API is called before depositing funds via the merchant reserve. Any negative amount will be netted from available merchant payout at the time of settlement.

The reserveAmount represents the available reserve funds. The reserve is an account within the Ansa platform that is funded in advance to power different parts of the closed-loop network, such as promotional accounts and the wallet funding hold account.

Authorization Scope

Only the merchant secret key is authorized to call this endpoint.

200200

400400

500500