Release Notes for Payway 4.5¶

Target Audience: Users, Developers, Stakeholders

Minor Releases¶

4.5.9 (2022-10-10)¶

Issues fixed¶

PAP: Issue fixed where payment options not supported by flex campaigns could sometimes be selected as a transition period. Read more here.
PAP: Issue fixed where subscription numbers would sometimes not carry over for package changes.
PAP: Issue fixed where flex campaigns could result in an endless loop.
PAP: Issue fixed where HTML widgets could be saved with an invalid title.
PAP: Issue fixed where inactive age validations would still display an error message when setting up a package/campaign.
PAP: Issue fixed where the GLN number was limited to 13-14 numbers when starting a Billecta e-invoice subscription.
PAP: Issue fixed where the password reset link could sometimes not be requested for a customer.
PAP: Issue fixed where a Billecta invoice would be sent directly after reactivation, although it should have been sent at a later date.
PCP: Issue fixed where gift vouchers targeting a print product could sometimes not be redeemed.
Payway API: Issue fixed where we would not check against strict traffic sources in the Klarna Instant Shopping initialize_purchase endpoint.
Payway API: Issue fixed where purchase_type would be incorrect for events related to flex campaigns.
Payway API: Issue fixed where subscription_end_date would be incorrect for gift vouchers, when fetching subscriptions for a customer.

Changes¶

PAP: Adyen V68 along with SDK version 5.23.1 is now supported in the payment method configuration.
Payway API: The /get_purchasable_product_code endpoint will now return the given package/campaign code, if it is not included in an active ranked campaign group.
Payway API: Accounts can now be found using the tulo customer number in the Account API. Read more here.
Payway API: Marketing API V6 now has a recursive transition_period object for each price period, describing the entire flex campaign chain. Read more here.
Payway API: Product API V4 now has a recursive transition_period object for each price period, describing the entire flex campaign chain. Read more here.
Payway API: Campaign period iterations, describing how many months a campaign will renew for, has now been added to the following APIs:

New features¶

PAP: The configuration for integrations with subscription systems can now be configured in the controlpanel. Read more here.
- Created campaigns can also be exported to the following subscription systems: Kayak.
- In order to start exporting created campaigns to your subscription system, contact our support.
PCP: Cancelling a subscription now has an additional step, showing a page confirming the cancellation for the end user.
Payway API: New endpoint to check whether a user is allowed to purchase a gift campaign. Read more here.

4.5.8 (2022-09-20)¶

Issues fixed¶

PCP: Issue fixed where /v2/give_gift/ would not consider the sales period of a product.
PCP: Issue fixed where a customer in rare cases could both accept a retention campaign and cancel their subscription.
PAP: Issue fixed where a fully paid Billecta invoice could no longer be credited.
PAP: Issue fixed where a failed order could not be opened.
PAP: Issue fixed where a Gift Voucher order could not be opened, if it was not yet redeemed.
PAP: Creating a voucher no longer allows the user to select an inactive package.
PAP: Issue fixed where the age validation view would have a broken "Back" button for campaigns.
Payway API: Issue fixed where Gift Vouchers and campaigns would not be compatible.

Changes¶

PAP: Coupons temporarily disabled, as their functionality cannot currently be ensured.
PAP: Improved error messages when crediting a Billecta invoice.
PAP: Package overview overhauled to drastically improve performance.
PAP: Integration code can now be used when searching for a package.
PAP: Integration code can now be used when searching for a campaign.
PAP: Color changes to the staging environment to make it more clear which environment the user is in.
PAP: Quality of Life changes when creating a new campaign.
PAP: Quality of Life changes in the subscription period overview of a customer.
PAP: Failed Adyen refunds will now log to the account timeline.
PAP: Address changes have been re-enabled.
PCP: The purchase history tab can now differentiate between normal and gift voucher purchases.
PAP & PCP: Max length of zip-code ensured to be 6 in all cases.
Payway API: Added support for dropbox in the Create Order endpoint.

New features¶

Payway API: period_id added to voucher_details, available when fetching a voucher from the Voucher API.

4.5.7 (2022-08-29)¶

Issues fixed¶

PAP: Issue fixed where API users with the same name could not be created on multiple organisations.
PAP: Issue fixed when changing a digital package to a package with a paper product.
PAP: Issue fixed with GLN (Global Location Number) validation for Billecta E-invoice.
PAP: Issue fixed with the package and campaigns list for marketplace.
PARP: Issue fixed where the cancel button did not work.
Kayak export: Issue fixed where renewal of package change resulted in a export error
External API: Issue fixed with wrong price description for the Product API V3.

Changes¶

PPF: Subscriptions paid with Adyen Swish will now get access immediately, deactivates if payment is unsuccessful after Adyen notification.
PAP Improvements to delivery and billing addresses for subscriptions payed with Billecta.
Adyen: If Adyen cannot credit a payment due to insufficient funds on merchant account, an account timeline post will be recorded.

New features¶

External API: Gift vouchers can be bought through Adyen API place_order. Read more here
External API: Delivery address can now be provided when redeeming vouchers. Read more here
External API: New endpoint on Me API to fetch purchased vouchers. Read more here
PPF: Future start dates can now be selected for limited subscriptions.
PPF: Customer will be notified by mail 14 days before subscription is up- or downgraded due to age validation.
PAP: The customers purchased vouchers can now be found in the left menu.
PAP: Billecta invoices can be credited and subscription reactivated.
PAP: Billecta invoices can be credited and subscription cancelled.
PCP: A confirmation is now shown when cancelling or reactivating a subscription.
Adyen: For a better customer experience a merchant image url is now sent to Adyen.
Adyen notifications: HMAC validation is now available. For more information contact Payway support

4.5.6 (2022-06-30)¶

Issues fixed¶

PAP: Issue fixed where receiving a error while creating a campaign would still save the campaign and cause a bad state.
PAP: Issue fixed where the Adyen payment configuration would incorrectly require the origin key/url fields to be filled in.
PAP: Issue fixed where the campaign table/overview would in some cases take painfully long to load in.
- Default view will limit results to 25 rows
- Searching/filtering will limit results to 50 rows
PAP: Issue fixed where the subscription period information would display incorrect end dates for Billecta subscriptions.
PAP: Issue fixed where the country code list when starting a subscription for a customer would in some cases only include one country.
Payway API: Issue fixed where start_date would incorrectly not be optional in the Create Order V2 API.

Changes¶

PAP: Limited subscriptions can no longer have their end date set to the past.
PAP: Flex campaigns can no longer transition to itself.
PAP: Added traffic_source to the order details page.
PAP: "Distribution" link (for those with distribution enabled) no longer visible for everyone. Required role is now "Tulo Distribution Manager".
PCP: Payment periods on flex campaigns without a set transition period will no longer be included in our purchase flow(s), as this would result in broken behaviour later on.
PCP: Issue fixed where first- and last name fields would sometimes not display as mandatory, even although they were configured as such.

New features¶

PAP: Added Payment Profiles for Adyen. This will allow you to start subscriptions from admin and our API's, with card details that have already been saved from a previous purchase they have made.
- Read more about payment profiles here.
- This feature is by default disabled. To get started with payment profiles, please contact our support.
PAP: Added Ranked Campaign Groups, which will allow you to create a collection of campaigns on a specified package, with customizable internal ordering.
- Read more about ranked campaign groups here.
PAP: Added information on the subscription overview for a customer, stating how many physical copies will be distributed (for those with distribution).
PAP: Extended the functionality of Marketplace HTML and CSS templates:
- Marketplace and marketplace groups are now controlled by a so-called theme. Read more about themes here.
- Themes in turn decide which HTML template and CSS templates that should be used.
- HTML templates can take use of HTML widgets in order to separate code and add some versatility for different titles.
- This will not change the behaviour of marketplaces inherently, but instead open up the usage of our Marketing API's.

4.5.5 (2022-06-08)¶

Issues fixed¶

Payway API: Issue fixed where the Account API and Me API endpoints would return 500 for flex campaigns with multiple campaigns.
PAP: Issue fixed where payment configurations would sometimes save an incorrect password, causing the payment method to fail.
PAP: Issue fixed where creating a subscription from admin would not take timezones into consideration.
PAP: Issue fixed where subscriptions without an order id would prevent sharings from being created/working correctly.
PCP: Issue fixed where Klarna addresses would in some cases not be parsed correctly.
PCP: Issue fixed where the flex campaign price description would be incorrect for campaigns with multiple iterations.

Changes¶

Payway API: Added support to update a customers birthdate through the Account API and Me API Update endpoints.
Payway API: Added support to set a customers birthdate through the Account API Create endpoint.
PAP: Statistics view have been deprecated and Redash will from now on instead be used. For more information or help in setting up Redash, contact our support.

New features¶

Payway API: New Account API endpoint to create an order. Read more here.
Payway API: New Me API endpoint to create an order on behalf of a customer. Read more here.
PAP: Added the option to immediately terminate a subscription that was previously cancelled at period end.
PAP: Added company and citizenship-related fields when creating a Billecta-based subscription from admin (allowing subscriptions to be created for foreign customers).

4.5.4 (2022-05-19)¶

Issues fixed¶

PAP: Issue fixed where upgrades/downgrades performed via PAP would not be exported correctly.
PAP: Issue fixed where order validation fallback- and transition packages could not be set up correctly in the case of campaigns.
PAP: Issue fixed where the package table would sometimes show blank/white, without any indication on what happened/went wrong.
PAP: Issue fixed where the Field configuration table for packages would display incorrectly.
PAP: Issue fixed where failed Billecta-payments would sometimes fail to mark themselves as failed.
PAP: Issue fixed where retention campaigns with disabled payment periods would sometimes be incorrectly considered incompatible when setting up a retention campaign staircase.
PCP: Issue fixed where flex campaigns, where the last campaign would perform an ordinary transition to the base package, would not be included in the price string.
PCP: Issue fixed where the total price would sometimes not be shown in the case of flex campaigns, and the price-per-month would instead be shown.
Payway API: Issue fixed where Klarna trial-purchases would not be allowed in the case of flex campaigns.
Payway API: Issue fixed where the subscription_end_date would be incorrectly calculated for the Me API V2 in the case of flex campaigns.

Changes¶

Payway API: New fields added to the Order section of the order_closed event.

New features¶

PAP: Added support for Billecta e-invoices for companies, when starting a subscription for a customer via PAP.
- New fields: Company Registration Number (CRN), Global Location Number (GLN), Intermediator
PAP: Added an additional text to the subscription overview under a customer, describing what package/campaign the customer will transition to.
PCP: Added an additional text to the "My subscriptions" page, describing what package/campaign the customer will transition to.
PAP & PCP: Introduced a new toggleable feature, which will allow you to set the Payway account name to the given card holder name during the purchase flow.
- Contact our support for more information on how to start using this feature.
Payway API: Introduced a Marketing API V4, which will allow you to fetch prices and price descriptions excluding VAT.
Payway API: Introduced a Product API V3, which will allow you to fetch prices excluding VAT.

4.5.3 (2022-05-02)¶

Issues fixed¶

PAP: Issue fixed where some address fields would be emptied in the case of a validation error, while attempting to start a Billecta subscription.
PAP: Issue fixed where performing a deactivation, reactivation, and change of renewal date would not present any feedback that the action was performed.
PAP: Issue fixed where package sharings would sometimes still be shown on archived/deleted accounts.
PAP: Issue fixed where exporting helpdesk messages would never take more than 100 entries.
PAP: Issue fixed where orders created with a failed payment would not create a subscription, and as such show an error page while trying to view the order.
PAP: Issue fixed where pending package downgrades/changes would still exist after a subscription was upgraded/cancelled.
PAP & PCP: Issue fixed where package upgrades/downgrades/changes would still be incorrectly performed with a missing payment agreement.
Payway API: Issue fixed where attempting to fetch product start dates on products without an end date would result in an unexpected error.
Payway API: Issue fixed where /perform_additional_action would not perform as expected in the case of a cancelled order.

Changes¶

PAP: Added the possibility to enter a CO address and country when starting a new subscription for a customer.
PAP: Added a max-length limitation to the value column of the resource register, as to improve user experience in the case of longer values.
PAP & PCP: Added support for the Adyen CANCELLATION event code, to be able to handle and cancel payments via notifications.
PCP: Changed the order-/age validation that would previously only consider the year of the birth date, to now considering the whole birth date of the customer.

New features¶

PAP: Subscription status updated and informational text added to subscriptions that has failed to renew.
PAP: Package ranking implemented, which will allow you to set a rank on packages (campaigns inherit their rank).
- These ranks will decide how package changes are performed, if a rank is set on both the source and target package.
- Read more about package ranking here.
- Read more on how to set up package ranking here.
PAP: Transition package implemented for the package- and campaign based order/age validation.
- This will allow you to set up a package and period that the customer will transition to once the age criterion is no longer met.
- If a transition package is not set up, the subscription will be cancelled.
- Read more about this functionality here.

4.5.2 (2022-04-11)¶

Issues fixed¶

PAP: Issue fixed related to validation errors when editing Billecta payment provider configurations .
PAP: Issue fixed when changing package to any Adyen payment option.
PAP: Issue fixed where the save button for creating new subscriptions could be triggered multiple times.
PAP: Issue fixed where the account timeline would show the users email as creator instead of the admin email when a subscription was added.
PAP: Issue fixed where the description for a payment period was missing from flex campaigns.
PAP: Issue fixed where the wrong payment due date was displayed for Billecta subscriptions.
PAP: Issue fixed where reactivation of Billecta subscriptions did not start a new invoice period.
PAP: Issue fixed where an error page was shown if the order details were missing on the order.
PAP: Issue fixed where selected payment period was incorrectly mandatory for upgrade and downgrade package change.
PAP: Issue fixed where sometimes product could not be added when editing the market place.
External Marketing API: Issue fixed where direct-debit transition period would be required.
Payway API: Issue fixed for change_product in Me API where a subscription could not be changed to a campaign.

Changes¶

Payway API: Added order_id to the response for Account API invoice_order and Me API order
PAP: Added improved reactivation functionality for Billecta invoices.
PAP: Added an account timeline entry when a password is regenerated.
PAP: Added more visibility to uploaded logos under titles.
PCP: The required length of a phone number changed to shorter.

New features¶

PAP: Added the possibility to set shopper statement in the Adyen payment provider configuration.
PAP: Added Billecta invoice delivery methods to show on order details, payment details and invoice periods.
PAP: Added Billecta invoices to show as paid in Payway if they are credited to the sum of the invoice amount. Read more here
PAP: Added the option to select if traffic sources must be registered in PAP. Read more here
PAP: Added the possibility to change an address to abroad for Tulo distribution.
PAP: Added link to Tulo distribution for those who use distribution through Tulo.
PAP: Added cancellation reasons to the account timeline.
PAP: Added improved validation for Billecta payment provider configuration.
Kayak integration: Added functionality that changes cancellation reason if subscription can not be exported due to inactive in Kayak.
Documentation: Tulo invoice lifecycle

4.5.1 (2022-03-22)¶

Issues fixed¶

Payway API: Issue fixed where the Product API V2 endpoint would require transition periods for disabled campaign periods, and thus cause an incorrect error.
PAP: Issue fixed where the user experience when failing to select a period when changing the package for a customer would suffer.
PAP: Issue fixed where orders were incorrectly exported to Kayak in the event of a package change.

Changes¶

Payway API: redirectUrl parameter added to the Adyen Place Card Verification endpoint.
Payway API: Base package tags now included in the list of tags when fetching a campaign from the Marketing API V2 and Marketing API V3.
PAP: Disabled the option to select a future subscription start date for Limited Billecta subscriptions, as these are currently not supported.
PAP: Disabled the Change Package functionality for all Billecta subscriptions.
PAP: Disabled the option to swap the current subscription of a customer into a Billecta subscription.
PAP: Added a info-section describing the subscription the customer currently has when going to Change package.
Payway Email Service: Added state to the PWSubscription payload.

New features¶

PAP: Added column sort functionality to the invoice periods overview.
PAP: Added the option to not send out the first invoice when starting a Billecta subscription on behalf of a customer.

4.5.0 (2022-03-03)¶

Issues fixed¶

Payway API: Improved error handling for the entire me_api
Payway API: Improved error handling for /accounts/invoice_order
PAP: Issue fixed where products on a marketplace would be blanked out, if an error occurred along the way.
PAP: Issue fixed where Adyen and Billecta payment periods could not be created if they were pre-selected when editing payment options.
PAP: Issue fixed where reactivation of Billecta subscriptions would result in duplicate invoice periods.
PCP: Issue fixed where logged in customers, without a customer number and address, would experience unexpected behaviour.

Changes¶

Payway API: subscription_end_date added to the Me API V2 and Account API V1, signifying when a subscription will come to an end.
Payway API: campaign_end_date added to the Me API V2 and Account API V1, signifying when a campaign will come to an end.
Payway API: price_description included in each price period when fetching products from the Product API V2
Payway API: The user product property has_pending_change_request has been moved to the Me API V2.
Payway API: subscription_type now showing as limited if the subscription is based on a non-transitioning campaign or a limited package.
- Affected endpoints are: Me API V2 and Account API V1.
Payway Docs: SSO2 Documentation extended with a "Best Practices" section. Read more here.
PAP: Package changes that would result in cross-merchant purchases no longer allowed (applicable for Klarna and Adyen).
PPF: Order validation now includes passive customers (applicable for Kayak subscription systems).

New features¶

Improved handling for externally provisioned subscriptions in intermission. Adjusted subscription end date according to the intermission (applicable for Kayak subscription systems).
PAP: Improved management of invoice (Billecta) subscriptions
- Better overview of current invoicing
- Easier adjustment of subscription period. Invoicing is automatically adjusted according to the renewal date.
- Reactivation of Billecta subscriptions now automatically restarts invoicing.
PAP: Overhauled the initial view of the PAP, now allowing Customer Service to search for customers, orders, payments, and invoices (if you're using Billecta) separately.