Error
A valid request URL is required to generate request examples[
{
"id": "<string>",
"batchName": "<string>",
"status": "<string>",
"currency": "<string>",
"totalAmount": 123,
"totalPayments": 123,
"successfulPayments": 123,
"failedPayments": 123,
"pendingPayments": 123,
"createdAt": "2023-11-07T05:31:56Z",
"progress": [
{
"step": "<string>",
"status": "<string>",
"message": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"details": {}
}
]
}
]Bulk Payments
Create Bulk Payment Batches
POST
/
api
/
v3
/
dashboard
/
bulk-payments
/
api
/
batches
/
create
Error
A valid request URL is required to generate request examples[
{
"id": "<string>",
"batchName": "<string>",
"status": "<string>",
"currency": "<string>",
"totalAmount": 123,
"totalPayments": 123,
"successfulPayments": 123,
"failedPayments": 123,
"pendingPayments": 123,
"createdAt": "2023-11-07T05:31:56Z",
"progress": [
{
"step": "<string>",
"status": "<string>",
"message": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"details": {}
}
]
}
]Create bulk payment batches from validated payment data.
Body
application/json
Batch name
Recipients list
Show child attributes
Show child attributes
Currency wallet selections
Show child attributes
Show child attributes
Batch description
Callback URL for notifications
For admin use - integrator ID
Response
201 - application/json
Created bulk payment batch
Batch ID
Batch name
Batch status
Currency
Total amount
Total payments count
Successful payments count
Failed payments count
Pending payments count
Created date
Progress tracking
Show child attributes
Show child attributes