---
title: "Cancel pending bulk payments"
method: POST
path: "bulk-payments/{bulkPaymentId}/payments/cancel"
tags: ["Bulk Payments"]
---

# Cancel pending bulk payments

`POST bulk-payments/{bulkPaymentId}/payments/cancel`

## Request

- Base URL: `https://payments.air-pay.io`
- URL: `https://payments.air-pay.io/bulk-payments/{bulkPaymentId}/payments/cancel`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/docs/bulk-payments/:bulkPaymentId/payments/cancel/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint enables users to manually cancel specific or all `pending`
individual payouts within a bulk payment. Users can input transaction
`hash` IDs for specific pending payouts they wish to cancel, retrievable
from the GET bulk payments by id. If no hash is included in the request
body, the endpoint will cancel all pending payouts associated with the
bulk payment. Pending payouts will automatically cancel after 90 days
(by default, other time periods are avilable in dashboard settings) from
the creation date. Once canceled, funds are automatically restituted to
user's Airtm balance, and individual payout status are updated to
`canceled`.

## Path parameters

- `bulkPaymentId` string

## Headers

- `Content-Type` string
- `Authorization` string

## Request body

- object
  - `paymentItems` object[]
    - `airtm_operation_hash` string

## Response `200`

OK

- object
  - `successful` string[]

## Other responses

- `422`: Bulk Payment ID not valid

---

[API](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1.md) - [All operations](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/revisions/4e8326a04343?raw)