> For the complete documentation index, see [llms.txt](https://developers.share.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.share.inc/api-reference/banking.md).

# Banking

Read-only access to wallet balances at provider and subscriber scope. Balances are the canonical ledger view — they reflect settled deposits, settled splits, and outstanding withdrawals. See the Revenue split concept guide for how partner and Share balances diverge across the payment lifecycle.

## Get provider balance

> Returns the aggregated ledger balance for the authenticated provider.

```json
{"openapi":"3.0.0","info":{"title":"Share API","version":"1.0"},"tags":[{"description":"Read-only access to wallet balances at provider and subscriber scope. Balances are the canonical ledger view — they reflect settled deposits, settled splits, and outstanding withdrawals. See the Revenue split concept guide for how partner and Share balances diverge across the payment lifecycle.","name":"Banking"}],"security":[{"X-Access-Secret":[]},{"X-Access-Id":[]}],"components":{"securitySchemes":{"X-Access-Secret":{"description":"Provider Access Secret Key (JWT)","in":"header","name":"X-Access-Secret","type":"apiKey"},"X-Access-Id":{"description":"Provider Access ID","in":"header","name":"X-Access-Id","type":"apiKey"}},"schemas":{"ApiResponseDto":{"properties":{},"type":"object"},"BalanceEntity":{"properties":{"balance":{"description":"Account balance","type":"number"},"currency":{"description":"Currency code (e.g. KES, USD)","type":"string"},"updatedAt":{"description":"Last balance update timestamp","format":"date-time","type":"string"}},"required":["balance","currency","updatedAt"],"type":"object"}}},"paths":{"/v1/banking/balance":{"get":{"description":"Returns the aggregated ledger balance for the authenticated provider.","operationId":"BankingController_getBalance_v1","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponseDto"},{"properties":{"data":{"$ref":"#/components/schemas/BalanceEntity"},"success":{"type":"boolean"}}}]}}},"description":"The current provider balance."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"rejectionReasons":{"items":{"properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"type":"object"},"type":"array"},"success":{"type":"boolean"}}}}},"description":"Validation failed"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Unauthorized — missing or invalid credentials"},"403":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Forbidden — insufficient permissions"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Resource not found"},"408":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Request timeout"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Internal server error"}},"summary":"Get provider balance","tags":["Banking"]}}}}
```

## Get subscriber balance

> Returns the ledger balance for a single subscriber owned by the authenticated provider.

```json
{"openapi":"3.0.0","info":{"title":"Share API","version":"1.0"},"tags":[{"description":"Read-only access to wallet balances at provider and subscriber scope. Balances are the canonical ledger view — they reflect settled deposits, settled splits, and outstanding withdrawals. See the Revenue split concept guide for how partner and Share balances diverge across the payment lifecycle.","name":"Banking"}],"security":[{"X-Access-Secret":[]},{"X-Access-Id":[]}],"components":{"securitySchemes":{"X-Access-Secret":{"description":"Provider Access Secret Key (JWT)","in":"header","name":"X-Access-Secret","type":"apiKey"},"X-Access-Id":{"description":"Provider Access ID","in":"header","name":"X-Access-Id","type":"apiKey"}},"schemas":{"ApiResponseDto":{"properties":{},"type":"object"},"BalanceEntity":{"properties":{"balance":{"description":"Account balance","type":"number"},"currency":{"description":"Currency code (e.g. KES, USD)","type":"string"},"updatedAt":{"description":"Last balance update timestamp","format":"date-time","type":"string"}},"required":["balance","currency","updatedAt"],"type":"object"}}},"paths":{"/v1/banking/balance/{subscriberId}":{"get":{"description":"Returns the ledger balance for a single subscriber owned by the authenticated provider.","operationId":"BankingController_getSubscriberBalance_v1","parameters":[{"description":"Subscriber identifier (UUID).","in":"path","name":"subscriberId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiResponseDto"},{"properties":{"data":{"$ref":"#/components/schemas/BalanceEntity"},"success":{"type":"boolean"}}}]}}},"description":"The current subscriber balance."},"400":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"rejectionReasons":{"items":{"properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"type":"object"},"type":"array"},"success":{"type":"boolean"}}}}},"description":"Validation failed"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Unauthorized — missing or invalid credentials"},"403":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Forbidden — insufficient permissions"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Resource not found"},"408":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Request timeout"},"500":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string"},"success":{"type":"boolean"}}}}},"description":"Internal server error"}},"summary":"Get subscriber balance","tags":["Banking"]}}}}
```