Skip to main content
This endpoint returns batch-level summaries only — it does not include each batch’s items. Use Get a bulk transfer for the full item breakdown of a specific batch.

​
Endpoint

​
Headers

​
string
required
Your public API key.
​
string
required
Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.
​
string
required
Your business ID.

​
Query parameters

​
integer
Page number. Defaults to 1.
​
integer
Records per page. Defaults to 20, capped at 100 — a limit above 100 is silently clamped down rather than rejected.
​
string
Filter to batches with this exact status — pending, processing, completed, failed, or partially_completed.
​
string
Filter to batches whose batchName contains this text. Case-insensitive, partial match.
​
string
Search across both batchName and bulkReference for this text. Case-insensitive, partial match. If you also pass batchName, both filters apply together.
​
string
ISO 8601 date — only include batches created on or after this date.
​
string
ISO 8601 date — only include batches created on or before this date.
See Pagination for full usage — this endpoint uses Shape B.

​
Response

​
boolean
true on success.
​
string
Human-readable outcome.
​
array
Array of bulk transfer batches, most recently created first.
​
string
The bulk transfer ID. Use with Get a bulk transfer to retrieve items.
​
string
Human-readable reference for this batch.
​
string
The name given to this batch on creation.
​
integer
Total number of transfers in the batch.
​
integer
Number of items currently completed.
​
integer
Number of items currently failed.
​
string
Sum of the amount of every item in this batch, in kobo — regardless of each item’s individual status. "0" if the batch somehow has no items.
​
string
Batch status. See statuses.
​
string
ISO 8601 timestamp of when the batch was created.
​
integer
The current page number.
​
integer
The page size used for this response.
​
integer
Total number of batches matching the current query, across all pages.
​
integer
The final page number, derived from total ÷ limit.

​
Code examples

​
Example response

Combine status, batchName, keyword, and the date range params freely — they all narrow the same result set together. For example, to find failed batches from July whose name mentions “salaries”:
cURL
status isn’t validated against the list of known statuses — passing a value that doesn’t match any batch (a typo, for instance) just returns an empty bulkTransfers array rather than a 400.

​
Errors