Balance API

The Balance API allows you to retrieve the current balance of funds in your Pin Payments account.

To initialize the Balance API, use the following:

from balance import Balance
from config import get_api_key

# Initialize the API with your API key and mode
balance_api = Balance(api_key=get_api_key(), mode='test')

Detail

Retrieves the current balance of the Pin Payments account.

Usage Example

response = balance_api.detail()
print(response)

Response Example

{
    "response": {
        "available": [
            {
                "currency": "AUD",
                "amount": "100000"
            }
        ]
    },
    "status": 200
}

Tip

Learn More

To learn more about balance functionality, refer to: pin_payments.balance