Get store balance (Partner API)

Server URLloading...

GET

/partner_api/stores/{storeId}/balance

Send

Authorization

Path

Returns the total available balance for a specific store. The balance represents the sum of available balances from all wallets associated with the store.

Balance Information:

• Returns the total available balance across all wallets for the store
• Available balance = total balance - blocked balance
• Balance is returned in the store's currency
• Amount is in cents (smallest currency unit)

Use Cases:

• Check store balance before creating transfers
• Display balance information in dashboards
• Monitor store financial status
• Validate sufficient funds for operations

Authentication: Requires API key headers.

Path Parameters

Response Body

curl -X GET "https://example.com/partner_api/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/balance"

{  "amount": 0,  "currency": "XOF"}