bulk_charge.md

BulkCharge

A collection of endpoints for creating and managing multiple recurring payments

Methods

Method	HTTP	Path	Summary
charges	GET	/bulkcharge/{code}/charges	List Charges in a Batch
fetch	GET	/bulkcharge/{code}	Fetch Bulk Charge Batch
initiate	POST	/bulkcharge	Initiate Bulk Charge
list	GET	/bulkcharge	List Bulk Charge Batches
pause	GET	/bulkcharge/pause/{code}	Pause Bulk Charge Batch
resume	GET	/bulkcharge/resume/{code}	Resume Bulk Charge Batch

---

charges

HTTP: GET
Path: /bulkcharge/{code}/charges

paystack.bulk_charge.charges(code, { ... })

Path Parameters

Name	Required
code	true

Query Fields

Name	Required
perPage	false
page	false
status	false

fetch

HTTP: GET
Path: /bulkcharge/{code}

paystack.bulk_charge.fetch(code)

Path Parameters

Name	Required
code	true

initiate

HTTP: POST
Path: /bulkcharge

paystack.bulk_charge.initiate({ ... })

list

HTTP: GET
Path: /bulkcharge

paystack.bulk_charge.list({ ... })

Query Fields

Name	Required
perPage	false
page	false
status	false

pause

HTTP: GET
Path: /bulkcharge/pause/{code}

paystack.bulk_charge.pause(code)

Path Parameters

Name	Required
code	true

resume

HTTP: GET
Path: /bulkcharge/resume/{code}

paystack.bulk_charge.resume(code)

Path Parameters

Name	Required
code	true