Mass payouts
Cancel a scheduled/recurring payout
This method allows you to cancel a scheduled/recurring payout that was previously created with the execute_at parameter. Only payouts that are scheduled in advance can be canceled using this endpoint. Once canceled, the payout will receive the status cancelled.
Please note: You must specify the payout id of the individual payout you wish to cancel, not the batch id.
Params:
- payout_id - the unique identifier of the planned payout you want to cancel. This should be the ID of the individual payout, not the batch ID.
post/v1/payout/{payout_id}/cancel
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
Cancel a scheduled payout
Changes
No recorded changes to this operation across all 1 revision of this API.