API Reference

Cancel payout

delete
https://api.mollie.com/v2/payouts/

Cancel a payout. A payout can only be canceled while it has the status requested. Once the payout moves to initiated, it is too late to cancel.

The canceled payout object is returned with the status set to canceled.

Access with

API key

Advanced access token with payouts.write

OAuth access with payouts.write

Path Params
string
required

Provide the ID of the payout.

Query Params
boolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Responses

Updated about 5 hours ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/hal+json

Updated about 5 hours ago