Skip to main content
GET
/
api
/
v1
/
payment-scheduler
/
batch
/
{batchId}
/
status
Get Batch Processing Status
curl --request GET \
  --url https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch/{batchId}/status \
  --header 'x-api-key: <api-key>'
{
  "statusCode": 200,
  "message": "Batch status retrieved successfully",
  "data": {
    "batchId": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
    "processingStatus": "COMPLETED",
    "approvalStatus": "APPROVED",
    "lastRunAt": "2026-06-05T09:00:00Z",
    "nextRunAt": null,
    "isActive": true,
    "recipients": {
      "total": 100,
      "valid": 100,
      "invalid": 0
    },
    "transactions": {
      "total": 100,
      "completed": 100,
      "failed": 0,
      "pending": 0,
      "completionPercentage": 100
    },
    "amounts": {
      "completed": 50000,
      "failed": 0,
      "total": 50000
    }
  }
}
​
batchId
string
required
The unique identifier of the batch.
{
  "statusCode": 200,
  "message": "Batch status retrieved successfully",
  "data": {
    "batchId": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
    "processingStatus": "COMPLETED",
    "approvalStatus": "APPROVED",
    "lastRunAt": "2026-06-05T09:00:00Z",
    "nextRunAt": null,
    "isActive": true,
    "recipients": {
      "total": 100,
      "valid": 100,
      "invalid": 0
    },
    "transactions": {
      "total": 100,
      "completed": 100,
      "failed": 0,
      "pending": 0,
      "completionPercentage": 100
    },
    "amounts": {
      "completed": 50000,
      "failed": 0,
      "total": 50000
    }
  }
}