Bulk order status
Bearer ds_live_ / ds_test_/api/v1/merchant/bulk/{id}Returns a bulk order with a result for every number. The order status is processing until every number has settled, then completed.
curl -X GET "https://finaldatasub.com/api/v1/merchant/bulk/BULK-DATA-0007" \
-H "Authorization: Bearer ds_live_YOUR_KEY" \
-H "Accept: application/json"Authentication
Send your secret API key in the header. Authorization: Token … and X-API-Key: … are also accepted.
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer ds_live_YOUR_KEY | Yes |
| Accept | application/json | Recommended |
Authentication failures (401 UNAUTHORIZED, 403 IP_NOT_ALLOWED / ACCOUNT_SUSPENDED / API_ACCESS_NOT_APPROVED, 429 RATE_LIMITED) are listed in Authentication.
Parameters
Responses
200 OK — OK · 404 Not Found — Not found
{
"status": "successful",
"data": {
"id": 57,
"reference": "BULK-DATA-0007",
"category": "data",
"status": "completed",
"total_items": 3,
"successful": 2,
"pending": 0,
"failed": 1,
"total_charged": "960.00",
"created_at": "2026-10-05T10:20:00+01:00",
"completed_at": "2026-10-05T10:20:41+01:00",
"items": [
{
"position": 1,
"phone": "08031234567",
"amount": null,
"status": "success",
"message": null,
"transaction_id": "DS261005102003A1B2C3D4",
"charged": "480.00"
},
{
"position": 2,
"phone": "08123456789",
"amount": null,
"status": "success",
"message": null,
"transaction_id": "DS261005102004E5F6G7H8",
"charged": "480.00"
},
{
"position": 3,
"phone": "09031234567",
"amount": null,
"status": "failed",
"message": "Transaction failed. Your wallet has been refunded.",
"transaction_id": "DS261005102005J9K0L1M2",
"charged": "480.00"
}
]
}
}Errors
Errors specific to this endpoint, in addition to the authentication and validation errors common to every request.
| Code | HTTP | When |
|---|---|---|
| NOT_FOUND | 404 | No bulk order with this id or reference. |
Notes
- Item statuses are
success,pendingorfailed.amountis set for airtime items only. chargedis the item transaction's charge — for failed items it was refunded and is not counted intotal_charged.