-
Payment API: paymentRequired and quantities
Update:
Deprecating:
- Agreement and Payment property:
"paymentRequired" - Agreement property:
"defaultQuanity" - Subscription and AddOn property:
"quantity"
During 2026 we will implement a series of backward-compatible optimisations in the Payment API. These improvements aim to simplify maintenance of the source code, ensure stability, and make it easier for new integrators to work with the Payment API.
Payment Required
We found that the property “
paymentRequired” caused unnecessary confusion and chose to phase it out from various user interfaces during 2024, reducing its usage intentionally. With this update we also ignore the property, should it be provided by integrators.The original intention behind “
paymentRequired” was to address arrears on an unpaid subscription – for example, when a payment card expired, and the subscription required payment for its service.This made sense for commercial products, but not for donations, and thus created unnecessary confusion and complexity in the overall solution.
Quantity
Similarly, variations of “quantity” are suited for subscriptions of physical goods, but not for donations, which furthermore added unnecessary confusion.
With this update we ignore the above mentioned properties should they be provided by integrators.
- Agreement and Payment property:
-
Payment API: Unpaid, expectedTs og First-scheduleTypes
Update:
Tags: Payment APIIntroducing:
- Payment state:
"Unpaid" - Payment timestamp:
"expectedTs"
Deprecating:
- The follow Agreement Schedule Types:
YearlyFirstHalfyearlyFirstQuarterlyFirstMonthlyFirstWeeklyFirst
During 2026 we will implement a series of backward-compatible optimisations in the Payment API. These improvements aim to simplify maintenance of the source code, ensure stability, and make it easier for new integrators to work with the Payment API.
State: Unpaid
The Payment state: “
Unpaid” is assigned to Pending payments that have not been charged three months afterdueDateTs, without any error detected.Common examples are Direct Debit claims with Arion Banki or FI-kort (giro) via Betalingsservice, e.g. FI-kort has been sent by post, but it has not been paid and we have no options to check its status.
The Unpaid state reflects that no further action will be made for this particular payment, and allows for anonymisation which is prohibited Contacts with Pending Payments. However, should the Payment be paid at a later time, the Payment state will be updated to: “Charged”.
No webhook is sent when the state is set to “Unpaid”, as we consider this a non-action.
Timestamp: expectedTs
The new “
expectedTs” timestamp indicates when the payment is expected to be processed and is shared across all Payment Types. In practice, this timestamp corresponds to the following for each Payment Type:- Single: “
chargedTs“ - OneOff: “
chargedTs“ - Recurring: “
dueDateTs“
Our aim is to help analysis and pivot across all Payment Types.
Schedule Types with First
The following existing schedule types are being deprecated in favour of variants without the suffix “First”:
YearlyFirstHalfyearlyFirstQuarterlyFirstMonthlyFirstWeeklyFirst
Our aim is to narrows the scope of options for integrators.
The use of “*First” was generally very limited and Agreements with such scheduleTypes have been updated accordingly.
- Payment state:
-
Swish Single
Update:
Introducing:
paymentGatewayProvider: "Swish"paymentMethodType: "SwishSingle"
We recently introduced Swish as a new Payment Gateway, and are now expanding our implementation with Single Payments.
The API documentation have been updated accordingly:
-
Swish Recurring
Update:
Introducing:
paymentGatewayProvider: "Swish"paymentMethodType: "SwishRecurring"
We have introduced a new Payment Gateway in Payment API for integration with the Swedish payment service: Swish, available in Forms for Swedish organisations.
It will later be available in Onboarding for telemarketing and face-to-face in compliance with Swedish law.
In this initial release, we only support Recurring Payments, but will expand with Single Payments in the near future.
The API documentation have been updated accordingly: