Balance.md

paystack.Balance

All URIs are relative to https://api.paystack.co

Method	HTTP request	Description
fetch	GET /balance	Fetch Balance
ledger	GET /balance/ledger	Balance Ledger

fetch

Response fetch()

Fetch Balance

You can only transfer from what you have

Example

• Bearer Authentication (bearerAuth):

importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'# Fetch Balanceresponse=paystack.Balance.fetch()
pprint(response)

Parameters

This endpoint does not need any parameter.

Return type

Response

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request successful	-
401	Unauthorized operation	-
404	Entity not found	-
0	Server error	-

[Back to top][Back to API list][Back to Model list][Back to README]

ledger

Response ledger(per_page=per_page, page=page, _from=_from, to=to)

Balance Ledger

Example

• Bearer Authentication (bearerAuth):

importpaystackfrompprintimportpprint# Set your API key based on domain (test or live mode)paystack.api_key='sk_domain_xxxxxxxx'# Balance Ledgerresponse=paystack.Balance.ledger(
)
pprint(response)

Parameters

Name	Type	Description	Notes
per_page	int	Number of records to fetch per page	[optional]
page	int	The section to retrieve	[optional]
_from	datetime	The start date	[optional]
to	datetime	The end date	[optional]

Return type

Response

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request successful	-
401	Unauthorized operation	-
404	Entity not found	-
0	Server error	-

[Back to top][Back to API list][Back to Model list][Back to README]