Cancel a batch waiting for approval

curl --request POST \
  --url https://api.panoflow.io/v1/batches/{batch_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "Wrong file uploaded."
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({note: 'Wrong file uploaded.'})
};

fetch('https://api.panoflow.io/v1/batches/{batch_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/batches/{batch_id}/cancel"

payload = { "note": "Wrong file uploaded." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "bat_01JCYFGCW8T7SWM4FV4DK79Q9G",
  "object": "batch",
  "status": "canceled",
  "status_reason": "canceled_by_user",
  "source_account": {
    "id": "acc_01JCWPQ5E6EYCNDY0YP57RCYBV",
    "name": "Naira · Main",
    "currency": "NGN",
    "account_number_last4": "6789"
  },
  "file_name": "october-suppliers.csv",
  "total": {
    "amount": 648000000,
    "currency": "NGN"
  },
  "fee_total": {
    "amount": 193500,
    "currency": "NGN"
  },
  "counts": {
    "items": 36,
    "skipped": 2,
    "pending_approval": 0,
    "processing": 0,
    "completed": 0,
    "failed": 0,
    "canceled": 36
  },
  "created_by": {
    "type": "user",
    "id": "usr_01JCG0X454YG4GFDEXZR4YJ2C4",
    "name": "Ngozi Uche"
  },
  "created_at": "2026-10-28T08:30:00Z",
  "updated_at": "2026-10-28T08:44:00Z"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

POST

batches

{batch_id}

cancel

Cancel a batch waiting for approval

curl --request POST \
  --url https://api.panoflow.io/v1/batches/{batch_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "Wrong file uploaded."
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({note: 'Wrong file uploaded.'})
};

fetch('https://api.panoflow.io/v1/batches/{batch_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/batches/{batch_id}/cancel"

payload = { "note": "Wrong file uploaded." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "bat_01JCYFGCW8T7SWM4FV4DK79Q9G",
  "object": "batch",
  "status": "canceled",
  "status_reason": "canceled_by_user",
  "source_account": {
    "id": "acc_01JCWPQ5E6EYCNDY0YP57RCYBV",
    "name": "Naira · Main",
    "currency": "NGN",
    "account_number_last4": "6789"
  },
  "file_name": "october-suppliers.csv",
  "total": {
    "amount": 648000000,
    "currency": "NGN"
  },
  "fee_total": {
    "amount": 193500,
    "currency": "NGN"
  },
  "counts": {
    "items": 36,
    "skipped": 2,
    "pending_approval": 0,
    "processing": 0,
    "completed": 0,
    "failed": 0,
    "canceled": 36
  },
  "created_by": {
    "type": "user",
    "id": "usr_01JCG0X454YG4GFDEXZR4YJ2C4",
    "name": "Ngozi Uche"
  },
  "created_at": "2026-10-28T08:30:00Z",
  "updated_at": "2026-10-28T08:44:00Z"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

Idempotency-Key

string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

batch_id

string

required

bat_…

Pattern: ^bat_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

Optional note kept in the audit log.

note

string

Why it was canceled.

Maximum string length: 500

Response

Canceled.

A Pay many batch. Its rows are transfers with batch_id.

string

required

bat_…

object

string

required

Always batch.

Allowed value: "batch"

status

enum<string>

required

Lifecycle shared by every money-moving resource (CONVENTIONS §8). UI labels: completed → "Settled", pending_approval → "Pending approval".

Available options:

draft,

pending_approval,

scheduled,

processing,

completed,

failed,

rejected,

canceled,

reversed

source_account

object

required

Enough of a PanoFlow account to show it ("Naira · Main · ••••6789"). Full account in the Accounts API.

Show child attributes

total

object

required

Sum of the rows being paid.

Show child attributes

fee_total

object

required

Sum of the rows' fees.

Show child attributes

counts

object

required

How many of the batch's rows are in each state.

Show child attributes

created_by

object

required

Who did something. Shown in activity, approvals and the audit log.

Show child attributes

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

updated_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

status_reason

enum<string>

Sub-state of a batch's status. Clients must tolerate new values.

Available options:

awaiting_approval,

sending,

all_items_completed,

some_items_failed,

all_items_failed,

rejected_by_approver,

canceled_by_user,

approval_expired

file_name

string

File name, or "Pasted rows".

skipped_rows

object[]

Rows that were skipped and will never be paid. Returned on GET /batches/{id}; omitted in lists.

Show child attributes

approval

object

The batch's approval, when it needed one.

Show child attributes

reason

string

Why it was made (shown to the approver).

completed_at

string<date-time>

When the last row became final.

Example:

"2026-10-27T08:41:00Z"

metadata

object

Up to 20 string keys (≤ 40 chars) with string values (≤ 500 chars). Returned on the resource and its events.

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Cancel a batch waiting for approval

Authorizations

Headers

Path Parameters

Body

Response