post
https://api-sandbox.paymentlabs.io/batches//payments/cancel
Cancels every payment in a batch that can still be cancelled. The cancellations run in the background.
Use it to call off a whole payout run. Payments that are DRAFT, FAILED, RETURNED, WAITING_PAYABILITY or RESTRICTED
and not being sent are cancelled, with the reason Batch cancelled, exactly as Cancel Payment would cancel each one: service
fees are refunded for payments inside their grace period, and payment-status-changed fires for each. Payments already sent are
not affected. The batch itself stays.
Requires the Write permission.
Errors
404 NOT_FOUND: the batch does not exist.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
The operation succeeded. The response has no body.