MOmollie
Payouts API

Cancel payout

Changed on

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}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/payouts/{payoutId}
  • Auth
    • HTTP bearer
    • or HTTP bearer

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.

resourcestring required

Indicates the response contains a payout object. Will always contain the string payout for this endpoint.

idstring required

The identifier uniquely referring to this payout. Mollie assigns this identifier at payout creation time. Mollie will always refer to the payout by this ID. Example: payout_j8NvRAM2WNZtsykpLEX8J.

balanceIdstring required

The identifier of the balance that will be paid out. Example: bal_gVMhHKqSSRYJyPsuoPNFH.

descriptionstring nullable

The description that will appear on the bank statement for this payout.

status'requested' | 'initiated' | 'processing-at-bank' | 'completed' | 'failed' | 'canceled' required

The status of the payout.

createdAtstring required

The entity's date and time of creation, in ISO 8601 format.

initiatedAtstring nullable

The date and time the payout was initiated, in ISO 8601 format. This is the moment Mollie attempted to reserve the funds on the balance.

completedAtstring nullable

The date and time the payout was sent to the destination bank account, in ISO 8601 format. null if the payout has not completed yet.

canceledAtstring nullable

The date and time the payout was canceled, in ISO 8601 format. null if the payout was not canceled.

mode'live' | 'test' required

Whether this entity was created in live mode or in test mode.

testmodeboolean nullable

Whether to create the entity in test mode or live mode.

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

Example response

{
  "resource": "payout",
  "id": "payout_j8NvRAM2WNZtsykpLEX8J",
  "balanceId": "bal_gVMhHKqSSRYJyPsuoPNFH",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "My payout description",
  "status": "requested",
  "statusReason": {
    "code": "requested",
    "message": "The payout has been requested."
  },
  "createdAt": "2024-03-20T09:13:37+00:00",
  "initiatedAt": "2024-03-20T09:13:40+00:00",
  "completedAt": "2024-03-20T14:00:00+00:00",
  "mode": "live",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes