Terminal & Apple Pay API

Terminal

class djpaystack.api.terminal.TerminalAPI(client)

Bases: BaseAPI

Terminal API

send_event(terminal_id: str, type: str, action: str, data: Dict[str, Any]) → Dict[str, Any]

Send event to terminal

fetch_event_status(terminal_id: str, event_id: str) → Dict[str, Any]

Fetch terminal event status

fetch_terminal_status(terminal_id: str) → Dict[str, Any]

Fetch terminal status

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

List terminals

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

Fetch terminal details

update(terminal_id: str, name: str, address: str) → Dict[str, Any]

Update terminal

commission(serial_number: str) → Dict[str, Any]

Commission terminal

decommission(serial_number: str) → Dict[str, Any]

Decommission terminal

Virtual Terminal

class djpaystack.api.virtual_terminal.VirtualTerminalAPI(client)

Bases: BaseAPI

Virtual Terminal API

send_event(terminal_id: str, type: str, action: str, data: Dict[str, Any]) → Dict[str, Any]

Send event to virtual terminal

Apple Pay

class djpaystack.api.apple_pay.ApplePayAPI(client)

Bases: BaseAPI

Apple Pay API

register_domain(domainName: str) → Dict[str, Any]

Register domain for Apple Pay

list_domains(use_cursor: bool = False, per_page: int = 50, page: int | None = None) → Dict[str, Any]

List Apple Pay domains

unregister_domain(domainName: str) → Dict[str, Any]

Unregister Apple Pay domain

Quick Reference

from djpaystack import PaystackClient
client = PaystackClient()

# Terminal
client.terminal.send_event(terminal_id=..., type=..., action=..., data=...)
client.terminal.fetch_event_status(terminal_id=..., event_id=...)
client.terminal.fetch_terminal_status(terminal_id=...)
client.terminal.list()
client.terminal.fetch(terminal_id=...)
client.terminal.update(terminal_id=..., name=..., address=...)
client.terminal.commission(serial_number=...)
client.terminal.decommission(serial_id=...)

# Apple Pay
client.apple_pay.register(domain_name='example.com')
client.apple_pay.list()
client.apple_pay.unregister(domain_name='example.com')