menu

Payment API

What's on this page

API Reference / Release

Release

Payment method Klarna supports the release of authorized funds of a payment. If the order capture is partial, releasing the remaining amount is allowed. Releasing the authorization of a canceled or non-captured payment is not allowed.

Other payment methods do not support this functionality.

Multiple requests are allowed. The PSP forwards the request only once.

Release request

Is used to release the remaining amount of a previous authorization.

  • Resource: /api/v1/release
  • Method: POST
  • Content-Type: application/json
  • Authentication: basic auth
  • Supports idempotency
  • Parameters
Name Required Description Max Length
reference Yes The unique reference of the payment authorisation to release 255
description No The description of the release. If not provided we use the original payment description 255
webhookUrl No The webhook URL invoked for transaction changes. This overrides the merchant webhook if one is present. We do not validate this url 2000
notificationRequests No An object which is used to request Notifications for specific events related to this transaction.

Example

{
  "reference": "K1506151348179039.1",
  "description": "Partial Order Shipment",
  "webhookUrl" : "https://merchant.ecom/checkout/webhook?order=1234"
}

Release response

Response if the release is allowed

  • Status Code: 204
  • Content Type: application/json
  • Content: No Content

Response if the release was not allowed

  • Status Code: 400
  • Content Type: application/json
  • Content: Error