Payouts API
Cancel payout
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.
delete/v2/payouts/{payoutId}
Query parameters
testmodeboolean
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.
Headers
idempotency-keystring
Example:123e4567-e89b-12d3-a456-426
A unique key to ensure idempotent requests. This key should be a UUID v4 string.
Response
The canceled payout object.