Skip to main content
POST
/
api
/
v1
/
payment-scheduler
/
batch
Create Bulk Transaction Batch
curl --request POST \
  --url https://waas-staging.embedly.ng/api/v1/payment-scheduler/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "accountNumber": "<string>",
  "batchReference": "<string>",
  "executionMode": "<string>",
  "scheduleType": "<string>",
  "scheduledAt": "<string>",
  "recurrencePattern": "<string>",
  "recurrenceInterval": 123,
  "recurrenceDays": "<string>",
  "recurrenceEndAt": "<string>"
}
'
{
  "statusCode": 200,
  "message": "Batch created successfully",
  "data": {
    "batchId": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
    "batchReference": "PAYROLL-2026-06",
    "approvalStatus": "PENDING",
    "processingStatus": "PENDING",
    "totalRecipients": 100,
    "validRecipients": 100,
    "invalidRecipients": 0,
    "totalAmount": 50000,
    "validationErrors": [],
    "createdAt": "2026-06-05T09:00:00Z"
  }
}
​
accountNumber
string
required
Debit account for the batch
​
batchReference
string
required
Unique batch reference
​
executionMode
string
required
IMMEDIATE or SCHEDULED
​
csvFile
file
required
Upload containing recipient rows
​
scheduleType
string
Required only for scheduled execution
​
scheduledAt
string
Required only for scheduled execution (ISO 8601 DateTime)
​
recurrencePattern
string
Required for recurring schedules
​
recurrenceInterval
number
Recurrence interval value
​
recurrenceDays
string
Comma-separated days for weekly patterns
​
recurrenceEndAt
string
End date for recurring schedules (ISO 8601 DateTime)
{
  "statusCode": 200,
  "message": "Batch created successfully",
  "data": {
    "batchId": "08ddaf4f-77d9-4336-8e62-358d622f09e9",
    "batchReference": "PAYROLL-2026-06",
    "approvalStatus": "PENDING",
    "processingStatus": "PENDING",
    "totalRecipients": 100,
    "validRecipients": 100,
    "invalidRecipients": 0,
    "totalAmount": 50000,
    "validationErrors": [],
    "createdAt": "2026-06-05T09:00:00Z"
  }
}