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

GET /clients/business/customers/funds/bulk-transfers

​
Headers

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

​
Query parameters

​
page
integer
Page number. Defaults to 1.
​
limit
integer
Records per page. Defaults to 20.
See Pagination for full usage — this endpoint uses Shape B.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data.bulkTransfers
array
Array of bulk transfer batches, most recently created first.
​
data.bulkTransfers[].id
string
The bulk transfer ID. Use with Get a bulk transfer to retrieve items.
​
data.bulkTransfers[].bulkReference
string
Human-readable reference for this batch.
​
data.bulkTransfers[].batchName
string
The name given to this batch on creation.
​
data.bulkTransfers[].totalItems
integer
Total number of transfers in the batch.
​
data.bulkTransfers[].completedItems
integer
Number of items currently completed.
​
data.bulkTransfers[].failedItems
integer
Number of items currently failed.
​
data.bulkTransfers[].status
string
Batch status. See statuses.
​
data.bulkTransfers[].createdAt
string
ISO 8601 timestamp of when the batch was created.
​
pagination.page
integer
The current page number.
​
pagination.limit
integer
The page size used for this response.
​
pagination.total
integer
Total number of batches matching the current query, across all pages.
​
pagination.totalPages
integer
The final page number, derived from total ÷ limit.

​
Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/business/customers/funds/bulk-transfers?page=1&limit=20" \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/business/customers/funds/bulk-transfers?page=1&limit=20",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data, pagination } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business/customers/funds/bulk-transfers",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    params={"page": 1, "limit": 20},
)
print(res.json())

​
Example response

{
  "status": true,
  "message": "Bulk transfers retrieved successfully",
  "data": {
    "bulkTransfers": [
      {
        "id": "6f9d3e2a-1b4c-4a8d-9e2f-3c1a2b4d5e6f",
        "bulkReference": "BULK-a1b2c3d4e5f6g7h8i9j0",
        "batchName": "July salaries",
        "totalItems": 2,
        "completedItems": 1,
        "failedItems": 1,
        "status": "partially_completed",
        "createdAt": "2024-07-01T09:00:00.000Z"
      }
    ]
  },
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

​
Errors

StatusCause
401 UnauthorizedbusinessId header missing, or credentials invalid — see Errors