Migration to 2025-12-09

Introduction

This migration guide outlines the changes introduced in the 2025-12-09 release. This version introduces Quickpay and Swedish eHealth Agency as new payment providers, adds settle schedules and close conditions for automatic payment order lifecycle management, and adds a new query parameter for filtering payments by consent.

Overview of Changes

New Payment Providers:

Quickpay

Quickpay has been added as a new payment provider, enabling Vipps payments. To initiate a payment, use provider: "quickpay" and method: "vipps" in the initiate payment request. Quickpay Vipps supports NOK and SEK.

Swedish eHealth Agency

Swedish eHealth Agency has been added as a new payment provider, enabling fritidskortet payments. To initiate a payment, use provider: "swedish_ehealth_agency" and method: "fritidskortet" in the initiate payment request. Fritidskortet only supports SEK payments.

Settle Schedule and Close Condition

Payment orders can now be configured with automatic settlement and closure behavior. A settle_schedule defines when a payment order is settled (using an absolute timestamp, a relative duration, or a cron expression), and a close_condition defines when a payment order is automatically closed (based on completed payment count or total completed amount). Both fields are optional and can be set when creating or updating a payment order.

To learn more, see the guide on configuring automatic settlement.

New Query Parameter: payment_consent_id on Get Payments

The Get Payments endpoint (GET /payments/api/v1/payments) now supports filtering by payment_consent_id as an optional query parameter.

ParameterTypeDescription
payment_consent_iduuidFilter the returned payments to only those associated with the specified payment consent.

Example request:

GET /payments/api/v1/payments?payment_consent_id=<uuid>

Affected Endpoints

  • Initiate Payment
  • Create Payment Order
  • Update Payment Order
  • Get Payments