payment_request.md

PaymentRequest

A collection of endpoints for managing invoices for the payment of goods and services

Methods

Method	HTTP	Path	Summary
archive	POST	/paymentrequest/archive/{id}	Archive Payment Request
create	POST	/paymentrequest	Create Payment Request
fetch	GET	/paymentrequest/{id}	Fetch Payment Request
finalize	POST	/paymentrequest/finalize/{id}	Finalize Payment Request
list	GET	/paymentrequest	List Payment Request
notify	POST	/paymentrequest/notify/{id}	Send Notification
totals	GET	/paymentrequest/totals	Payment Request Total
update	PUT	/paymentrequest/{id}	Update Payment Request
verify	GET	/paymentrequest/verify/{id}	Verify Payment Request

---

archive

HTTP: POST
Path: /paymentrequest/archive/{id}

paystack.payment_request.archive(id)

Path Parameters

Name	Required
id	true

create

HTTP: POST
Path: /paymentrequest

paystack.payment_request.create({ ... })

Body Fields

Name	Required
customer	true
amount	true
currency	false
due_date	false
description	false
line_items	false
tax	false
send_notification	false
draft	false
has_invoice	false
invoice_number	false
split_code	false

fetch

HTTP: GET
Path: /paymentrequest/{id}

paystack.payment_request.fetch(id)

Path Parameters

Name	Required
id	true

finalize

HTTP: POST
Path: /paymentrequest/finalize/{id}

paystack.payment_request.finalize(id)

Path Parameters

Name	Required
id	true

list

HTTP: GET
Path: /paymentrequest

paystack.payment_request.list({ ... })

Query Fields

Name	Required
perPage	false
page	false
customer	false
status	false
currency	false
from	false
to	false

notify

HTTP: POST
Path: /paymentrequest/notify/{id}

paystack.payment_request.notify(id)

Path Parameters

Name	Required
id	true

totals

HTTP: GET
Path: /paymentrequest/totals

paystack.payment_request.totals

update

HTTP: PUT
Path: /paymentrequest/{id}

paystack.payment_request.update(id, { ... })

Path Parameters

Name	Required
id	true

Body Fields

Name	Required
customer	false
amount	false
currency	false
due_date	false
description	false
line_items	false
tax	false
send_notification	false
draft	false
has_invoice	false
invoice_number	false
split_code	false

verify

HTTP: GET
Path: /paymentrequest/verify/{id}

paystack.payment_request.verify(id)

Path Parameters

Name	Required
id	true