Skip to main content
GET
/
api
/
v1
/
payment-scheduler
/
batch
/
{batchId}
Get Batch Details
curl --request GET \
  --url https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId} \
  --header 'x-api-key: <api-key>'
{
  "statusCode": 200,
  "message": "Batch retrieved successfully",
  "data": {
    "id": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
    "organizationId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "accountNumber": "1234567890",
    "batchReference": "PAYROLL-2026-06",
    "approvalStatus": "APPROVED",
    "executionMode": "SCHEDULED",
    "scheduleType": "DAILY",
    "scheduledAt": "2026-06-05T09:00:00Z",
    "recurrencePattern": "DAILY",
    "recurrenceInterval": 1,
    "recurrenceDays": "Mon,Tue,Wed,Thu,Fri",
    "recurrenceEndAt": "2026-12-31T23:59:59Z",
    "nextRunAt": "2026-06-06T09:00:00Z",
    "lastRunAt": "2026-06-05T09:00:00Z",
    "processingStatus": "COMPLETED",
    "createdAt": "2026-06-01T09:00:00Z",
    "updatedAt": "2026-06-05T09:00:00Z",
    "isActive": true,
    "totalRecipients": 100,
    "totalAmount": 50000
  }
}
​
batchId
string
required
The unique identifier of the batch.
{
  "statusCode": 200,
  "message": "Batch retrieved successfully",
  "data": {
    "id": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
    "organizationId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "accountNumber": "1234567890",
    "batchReference": "PAYROLL-2026-06",
    "approvalStatus": "APPROVED",
    "executionMode": "SCHEDULED",
    "scheduleType": "DAILY",
    "scheduledAt": "2026-06-05T09:00:00Z",
    "recurrencePattern": "DAILY",
    "recurrenceInterval": 1,
    "recurrenceDays": "Mon,Tue,Wed,Thu,Fri",
    "recurrenceEndAt": "2026-12-31T23:59:59Z",
    "nextRunAt": "2026-06-06T09:00:00Z",
    "lastRunAt": "2026-06-05T09:00:00Z",
    "processingStatus": "COMPLETED",
    "createdAt": "2026-06-01T09:00:00Z",
    "updatedAt": "2026-06-05T09:00:00Z",
    "isActive": true,
    "totalRecipients": 100,
    "totalAmount": 50000
  }
}