Sign in
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.

Changes

Changed in 5 of the 79 revisions of this API.36

  • 40ce187fe7291See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

  • 1fdc21356fc61See the full diff
    • ○

      the endpoint scheme security oAuth was removed from the API

      api-security-removed

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • c9097984fd6b23See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response's property type changed from no type to object null for status

      response-property-type-changed

    • ○

      removed from the response property allOf list for the response status

      response-property-all-of-removed

    • ○

      added the required property / to the response with the status

      response-required-property-added

    • ○

      added the required property / to the response with the status

      response-required-property-added

  • f5e0eb3b73131See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 79 revisions, 9 have no diff computed.