Sign in
Payments API

Release payment authorization

Releases the full remaining authorized amount. Call this endpoint when you will not be making any additional captures. Payment authorizations may also be released manually from the Mollie Dashboard.

Mollie will do its best to process release requests, but it is not guaranteed that it will succeed. It is up to the issuing bank if and when the hold will be released.

If the request does succeed, the payment status will change to canceled for payments without captures. If there is a successful capture, the payment will transition to paid.

post/v2/payments/{paymentId}/release-authorization

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

profileIdstring

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

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 request

{
  "profileId": "pfl_5B8cwPMGnU"
}

Response

The request was accepted and will be processed asynchronously.

Changes

Changed in 3 of the 92 revisions of this API.4

  • 64c0511a62bc1See the full diff
    • ○

      removed the pattern ^pfl_.+$ from the request property

      request-property-pattern-removed

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 92 revisions, 9 have no diff computed.