virtual_terminal.md

VirtualTerminal

A collection of endpoints for building in-person payments without a physical terminal

Methods

Method	HTTP	Path	Summary
add_split_code	PUT	/virtual_terminal/{code}/split_code	Add Split Code to Virtual Terminal
create	POST	/virtual_terminal	Create Virtual Terminal
deactivate	PUT	/virtual_terminal/{code}/deactivate	Deactivate Virtual Terminal
delete_split_code	DELETE	/virtual_terminal/{code}/split_code	Remove Split Code from Virtual Terminal
destination_assign	POST	/virtual_terminal/{code}/destination/assign	Assign Destination to Virtual Terminal
destination_unassign	POST	/virtual_terminal/{code}/destination/unassign	Unassign Destination from Virtual Terminal
fetch	GET	/virtual_terminal/{code}	Fetch Virtual Terminal
list	GET	/virtual_terminal	List Virtual Terminals
update	PUT	/virtual_terminal/{code}	Update Virtual Terminal

---

add_split_code

HTTP: PUT
Path: /virtual_terminal/{code}/split_code

paystack.virtual_terminal.add_split_code(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
split_code	true

create

HTTP: POST
Path: /virtual_terminal

paystack.virtual_terminal.create({ ... })

Body Fields

Name	Required
name	true
destinations	true
split_code	false
metadata	false

deactivate

HTTP: PUT
Path: /virtual_terminal/{code}/deactivate

paystack.virtual_terminal.deactivate(code)

Path Parameters

Name	Required
code	true

delete_split_code

HTTP: DELETE
Path: /virtual_terminal/{code}/split_code

paystack.virtual_terminal.delete_split_code(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
split_code	true

destination_assign

HTTP: POST
Path: /virtual_terminal/{code}/destination/assign

paystack.virtual_terminal.destination_assign(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
destinations	true

destination_unassign

HTTP: POST
Path: /virtual_terminal/{code}/destination/unassign

paystack.virtual_terminal.destination_unassign(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
targets	true

fetch

HTTP: GET
Path: /virtual_terminal/{code}

paystack.virtual_terminal.fetch(code)

Path Parameters

Name	Required
code	true

list

HTTP: GET
Path: /virtual_terminal

paystack.virtual_terminal.list({ ... })

Query Fields

Name	Required
perPage	false
page	false

update

HTTP: PUT
Path: /virtual_terminal/{code}

paystack.virtual_terminal.update(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
name	true