View Source Paystack.BulkCharge (Paystack v0.7.0)

The Bulk Charges API allows you create and manage multiple recurring payments from your customers

https://paystack.com/docs/api/#bulk-charge

Link to this section Summary

Functions

This endpoint retrieves a specific batch code. It also returns useful information on its progress by way of the total_charges and pending_charges attributes.

This endpoint retrieves the charges associated with a specified batch code. Pagination parameters are available. You can also filter by status. Charge statuses can be pending, success or failed.

Send an array of objects with authorization codes and amount (in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR ) so we can process transactions as a batch.

his lists all bulk charge batches created by the integration. Statuses can be active, paused, or complete.

Use this endpoint to pause processing a batch

Use this endpoint to resume processing a batch

Link to this section Functions

Specs

fetch_batch(String.t()) :: Paystack.Api.t()

This endpoint retrieves a specific batch code. It also returns useful information on its progress by way of the total_charges and pending_charges attributes.

Link to this function

fetch_batch_charges(id_or_code)

View Source

Specs

fetch_batch_charges(String.t()) :: Paystack.Api.t()

This endpoint retrieves the charges associated with a specified batch code. Pagination parameters are available. You can also filter by status. Charge statuses can be pending, success or failed.

Specs

initiate(list()) :: Paystack.Api.t()

Send an array of objects with authorization codes and amount (in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR ) so we can process transactions as a batch.

Specs

list_batches() :: Paystack.Api.t()

his lists all bulk charge batches created by the integration. Statuses can be active, paused, or complete.

Link to this function

list_batches(query_params)

View Source

Specs

list_batches(map() | list()) :: Paystack.Api.t()

Specs

pause_batch(String.t()) :: Paystack.Api.t()

Use this endpoint to pause processing a batch

Link to this function

resume_batch(batch_code)

View Source

Specs

resume_batch(String.t()) :: Paystack.Api.t()

Use this endpoint to resume processing a batch