Mass payouts
Cancel a scheduled/recurring batch
This endpoint allows you to cancel an entire recurring payout batch.
Once canceled:
-
No new payouts will be generated within the batch
-
Existing payouts that have not yet been processed will be canceled
-
The batch status will be updated accordingly
Params:
batch_id (required) - the unique identifier of the payout batch you want to cancel.
post/v1/payout/{batch_id}/cancel-batch
Request
- Base URLhttps://api.nowpayments.io
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
x-api-keystring
(Required) Your NOWPayments API key
Response
200
Changes
No recorded changes to this operation across all 1 revision of this API.