terminal.md

Terminal

A collection of endpoints for building delightful in-person payment experiences

Methods

Method	HTTP	Path	Summary
commission	POST	/terminal/commission_device	Commission Terminal
decommission	POST	/terminal/decommission_device	Decommission Terminal
fetch	GET	/terminal/{terminal_id}	Fetch Terminal
fetch_event_status	GET	/terminal/{terminal_id}/event/{event_id}	Fetch Event Status
fetch_terminal_status	GET	/terminal/{terminal_id}/presence	Fetch Terminal Status
list	GET	/terminal	List Terminals
send_event	POST	/terminal/{id}/event	Send Event
update	PUT	/terminal/{terminal_id}	Update Terminal

---

commission

HTTP: POST
Path: /terminal/commission_device

paystack.terminal.commission({ ... })

Body Fields

Name	Required
serial_number	true

decommission

HTTP: POST
Path: /terminal/decommission_device

paystack.terminal.decommission({ ... })

Body Fields

Name	Required
serial_number	true

fetch

HTTP: GET
Path: /terminal/{terminal_id}

paystack.terminal.fetch(terminal_id)

Path Parameters

Name	Required
terminal_id	true

fetch_event_status

HTTP: GET
Path: /terminal/{terminal_id}/event/{event_id}

paystack.terminal.fetch_event_status(terminal_id, event_id)

Path Parameters

Name	Required
terminal_id	true
event_id	true

fetch_terminal_status

HTTP: GET
Path: /terminal/{terminal_id}/presence

paystack.terminal.fetch_terminal_status(terminal_id)

Path Parameters

Name	Required
terminal_id	true

list

HTTP: GET
Path: /terminal

paystack.terminal.list({ ... })

Query Fields

Name	Required
next	false
previous	false
per_page	false

send_event

HTTP: POST
Path: /terminal/{id}/event

paystack.terminal.send_event(id, { ... })

Path Parameters

Name	Required
id	true

Body Fields

Name	Required
type	false
action	false
data	false

update

HTTP: PUT
Path: /terminal/{terminal_id}

paystack.terminal.update(terminal_id, { ... })

Path Parameters

Name	Required
terminal_id	true

Body Fields

Name	Required
name	false
address	false