Miscellaneous API

Utility endpoints: bank lists, countries, and more.

class djpaystack.api.miscellaneous.MiscellaneousAPI(client)

Bases: BaseAPI

Miscellaneous API

list_banks(country: str = 'nigeria', use_cursor: bool = False, per_page: int = 50, page: int | None = None, pay_with_bank_transfer: bool | None = None, pay_with_bank: bool | None = None, enabled_for_verification: bool | None = None, type: str | None = None, currency: str | None = None) → Dict[str, Any]

List banks

list_providers(pay_with_bank_transfer: bool | None = None) → Dict[str, Any]

List providers

list_countries() → Dict[str, Any]

List countries

list_states(country: int | None = None) → Dict[str, Any]

List states

Integration API

class djpaystack.api.integration.IntegrationAPI(client)

Bases: BaseAPI

Integration API

fetch_timeout() → Dict[str, Any]

Fetch payment session timeout

update_timeout(timeout: int) → Dict[str, Any]

Update payment session timeout

Bulk Charges API

class djpaystack.api.bulk_charges.BulkChargeAPI(client)

Bases: BaseAPI

Bulk Charges API

initiate(body: List[Dict[str, Any]]) → Dict[str, Any]

Initiate bulk charge

list(per_page: int = 50, page: int | None = None, from_date: str | None = None, to_date: str | None = None) → Dict[str, Any]

List bulk charges

fetch(id_or_code: str) → Dict[str, Any]

Fetch bulk charge

fetch_charges(id_or_code: str, status: str | None = None, per_page: int = 50, page: int | None = None, from_date: str | None = None, to_date: str | None = None) → Dict[str, Any]

Fetch charges in a batch

pause(batch_code: str) → Dict[str, Any]

Pause bulk charge

resume(batch_code: str) → Dict[str, Any]

Resume bulk charge

Products API

class djpaystack.api.products.ProductAPI(client)

Bases: BaseAPI

Products API

create(name: str, description: str, price: int, currency: str, unlimited: bool | None = None, quantity: int | None = None) → Dict[str, Any]

Create product

list(per_page: int = 50, page: int | None = None, from_date: str | None = None, to_date: str | None = None) → Dict[str, Any]

List products

fetch(id: str) → Dict[str, Any]

Fetch product

update(id: str, name: str | None = None, description: str | None = None, price: int | None = None, currency: str | None = None, unlimited: bool | None = None, quantity: int | None = None) → Dict[str, Any]

Update product

Settlements API

class djpaystack.api.settlements.SettlementAPI(client)

Bases: BaseAPI

Settlements API

list(per_page: int = 50, page: int | None = None, from_date: str | None = None, to_date: str | None = None, subaccount: str | None = None) → Dict[str, Any]

List settlements

fetch_transactions(id: str, per_page: int = 50, page: int | None = None, from_date: str | None = None, to_date: str | None = None) → Dict[str, Any]

Fetch settlement transactions

Quick Reference

from djpaystack import PaystackClient
client = PaystackClient()

# Miscellaneous
client.miscellaneous.list_banks(country='nigeria', currency='NGN')
client.miscellaneous.list_countries()
client.miscellaneous.list_states(country='NG')

# Integration
client.integration.fetch_payment_session_timeout()
client.integration.update_payment_session_timeout(timeout=30)

# Bulk charges
client.bulk_charges.initiate(charges=[...])
client.bulk_charges.list()
client.bulk_charges.fetch(id_or_code=...)
client.bulk_charges.fetch_charges_in_batch(id_or_code=...)
client.bulk_charges.pause(batch_code=...)
client.bulk_charges.resume(batch_code=...)

# Products
client.products.create(name=..., description=..., price=..., currency=...)
client.products.list()
client.products.fetch(id=...)
client.products.update(id=..., name=...)

# Settlements
client.settlements.list()
client.settlements.fetch_transactions(id=...)