Skip to main content
POST
/
v1
/
batches
/
{id}
/
cancel
Cancel a batch
curl --request POST \
  --url http://localhost:8080/v1/batches/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "bat_cq1234567890abcdef",
  "merchant_id": "<string>",
  "uploaded_by": "<string>",
  "status": "uploaded",
  "file_name": "<string>",
  "file_format": "csv",
  "file_size": 123,
  "total_rows": 123,
  "valid_rows": 123,
  "invalid_rows": 123,
  "processed_rows": 123,
  "errors": [
    {
      "row": 123,
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Path Parameters

id
string
required

Resource identifier (xid format)

Response

Batch cancelled

id
string
Example:

"bat_cq1234567890abcdef"

merchant_id
string
uploaded_by
string
status
enum<string>
Available options:
uploaded,
validating,
validated,
processing,
completed,
failed,
partial
file_name
string
file_format
enum<string>
Available options:
csv,
xlsx
file_size
integer<int64>
total_rows
integer
valid_rows
integer
invalid_rows
integer
processed_rows
integer
errors
object[]
created_at
string<date-time>
updated_at
string<date-time>
completed_at
string<date-time>