Bulk Payments

Cancel pending bulk payments

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.

postbulk-payments/{bulkPaymentId}/payments/cancel

Request

Base URL
https://payments.air-pay.io
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.

Path parameters

bulkPaymentIdstring

Headers

Content-Typestring

Example:application/json

Authorizationstring

Example:Basic {your_token}

Request body

Example request

{
  "paymentItems": [
    {
      "airtm_operation_hash": "CADBEW460EXAMPLE"
    }
  ]
}

Response

successfulstring[]

Example response

{
  "successful": [
    "CADBEW460EXAMPLE"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.