MOmollie
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.

🔑 Access with

API key

Advanced access token with payments.write

OAuth access with payments.write

post/payments/{paymentId}/release-authorization

Request

  • Base URL
    https://api.mollie.com/v2
  • URL
    https://api.mollie.com/v2/payments/{paymentId}/release-authorization
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: payments.write

Request body

profileIdstring

The identifier referring to the profile this entity belongs to.

When using an API Key, the profileId must not be sent since it is linked to the key. However, for OAuth and Organization tokens, the profileId is required.

For more information, see Authentication.

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.

unknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.