Version numbers: The version numbers used in headers on this page refers to the version of this very documentation, not to a version of any APIs described by it.
Version 5.2.0
The keen eye might spot the new term v3.x in Get Started and some of our code examples. We are using it as an umbrella term whenever we talk about all iterations of v3. Instances where we talk about a specific one are still tagged with the version in question.
We are also going live with an optional feature called Action Specific Text On Payment Button. It is meant for scenarios where you need the payment button to say something else than “Pay”. The alternative is currently limited to “Deposit”, but other can be added going forward.
Besides that we have been doing some small bugfixes and general maintenance.
Until next time!
Version 5.1.0
Re-working of the Modules & SDKs section is the star of this release. Intrigued? Start off with the bare minimum implementation!
Aside from that, this has been a maintenance release, but the release notes you are reading right now received a facelift. We have also added more information about the final steps before you go live!
Version 5.0.0
We strive to make the implementation process as easy as possible, and in that regard, a Get Started section has been introduced. This now includes the basic requests and responses, how to display the UI, post-purchase options and other useful information when doing a basic integration. The newest addition is an explanation on how to validate the status of the payment.
A new feature for those of you who want to customize the order of your payment menu has also seen the light of day, together with the possibility to expand the top method. They can be used independently, but work great together.
We also did a handful of bug fixes and corrections to improve usability and readability.
Version 4.8.0
A handful of changes in the pipeline this time around, with the biggest being the introduction of better error codes for excessive re-attempts. Read all about the error codes and how to test them here.
Are you in the market for One-Click payments? We have a new use case written about that. Give it a read!
Due to new directives from card companies regarding frictionless payments, we have re-introduced name fields in the payer object. Go see the fields you should include now.
We have also added the possibility to display a consent box for saving payment details. When displayed by you and checked by the payer, we have also added a new field in the paid response, confirming that a token has been created.
Big changes are coming up next time. Stay tuned!
Version 4.7.0
We spent some time building up steam after new years, but we have lots of treats lined up.
Are you looking to get started with recurring payments, but not really sure where to start? We have compiled everything you need in a use case, and walk you through it all.
Or are you maybe looking to upgrade to our newest Digital Payments version? See how easy it is in our migration guide.
A new errorType
goes live any day now, so a preview in the developer portal
seems fitting. The aim is to give you clearer feedback when a token has become
inactive. Read more about it in the problems section.
We have also made improvements to the domain verification steps of our Apple Pay documentation.
The Resources are being split up. We have moved the test-data and release notes up a level for convenience. Development guidelines are moved to Modules & SDKs if you need them. The partners are now on our front page and Data Protection can be found in Checkout v2.
In addition to the usual handful of improvements and bug fixes, of course.
Until next time!
Version 4.6.1
The last release of 2023 is finding its way down the chimney, and is mainly consisting of maintenance and small fixes.
There is however, one quite important update among the small ones. We have added a test data section for Network Tokenization, with both test cards and useful information. Head to the Network Tokenization feature section if you want to learn more about what it is.
From all of us, to all of you: Merry Christmas!
Version 4.6.0
Today, we go live with Payment Order v3.1, which has some changes in the
request, the post-purchase operations and the
callback. We have also added a new resource model called
failedPostPurchaseAttempts
. Go check it out!
There is a new section regarding Trustly in Digital Payments, with important information regarding overlay and Trustly Express.
There is also a new Vipps field for fees in the failedAttempts
resource
model.
Version 4.5.0
If you are reading these notes, you have probably noticed some changes already! As the Payment Terminals section is growing bigger, we have moved most of the Digital Payments related content away from the front page. The release notes can now be found where you are reading this, and the resources at the bottom of the front page will follow suit shortly.
The biggest news is the arrival of the Swedbank Pay Playground, where you can experience our payment solutions both as a payer and – since we give you access to the toolbox – a merchant. Play around with amounts, different menu setups (full menu, selected methods or a single method) and styling. It is also a great opportunity to see the upcoming accessibility compliant UI. Read more about accessibility changes here. With that in mind, we have also written a section regarding custom styling of your payment UI.
If you are looking for Cross Channel Payments and can’t find it, that is because we have renamed it Integrated Commerce.
Version 4.4.0
The wheels are picking up traction going into the autumn. Our first release after getting back is mostly maintenance and small fixes, but an important new addition is a section on Network Tokenization, which is a fantastic way of processing cards. Get to know it, and put it to use!
We have also adjusted our search results somewhat. Now we only display results from the sections Digital Payments and Payment Terminals. We hope it gives you an easier time finding the right result in the correct section.
Big things are coming up around the bend. Stay tuned!
Version 4.3.3
We had time for one more before we clock out for summer, so we added a PATCH example to our payout feature section. Go check it out if you are on your way to implementing it.
Have a great summer!
Version 4.3.2
A small batch of changes which barely missed the last deadline. We’ve done a few correction and some major changes, most notably the renaming of Checkout v3 to Digital Payments and Pax Terminal to Payment Terminal. The changes are in name only, the structure stays the same.
We have also added information regarding the Eligibility Check, and the availability of invoice for Swedish merchants, where the payment method integrations have been removed. You have to go through an implementation using payment order to offer this in Sweden.
Version 4.3.0
You spoke, we listened! We have worked a lot on making the portal easier to navigate. The main menu has been slimmed down, where we have removed the Introduction (but you can still read the main points under fundamental principles). If you are looking for the Modules & SDK]modules-sdks section, it has found a new home under Digital Payments.
Speaking of Digital Payments, we’ve cleaned that up as well, and hope it will make things easier for you. The payment request example now contains what you need to create a payment order. Adding more to it is up to you and the features section. The common implementations steps have been merged to avoid duplicate information, only sending you separate places when it’s time to display the ui.
A new terminal section has been added. Exciting things are coming, so we will make sure it grows and develops going forward.
Other highlights and important changes include:
- A new Payout section, currently supporting Trustly.
- An important field related to Network Tokenization has been added to the Paid models.
- A separate split settlement section, previously a part of settlement & reconciliation.
- Links to our partner pages.
- How to contact us before you get started.
- 3DS2 is now named Frictionless payments.
- Order items have been moved to optional features.
- Terms of Service has gotten its own optional feature.
Plus the usual handful of bug fixes and smaller changes.
Version 4.2.0
The keen observer might spot some changes in our menu. The Checkout v2, Payment Menu and Payment Methods have been moved to Old Implementations. You can still find everything you want and need, so no need to worry. A new .NET SDK section has also been added, in addition to the usual bugs and small fixes.
Version 4.1.0
A lot of changes are happening these days. We’ve made the decision to focus the Digital Payments offering, so our Starter and Business implementations are no more. This means that we can do what we do best: giving you a payment experience packed with options. The Payments Only implementation is still here, and for those of you with a Strong Consumer Authentication who want access to our safely stored card data, Enterprise is still available too.
Version 4.0.0
We promised you something big, and here it is. Click to Pay and Google Pay™ have been added to our arsenal of payment methods. Click on your method of choice to see what is needed for you to activate in your integration. We have also added information on how to activate Apple Pay, which we recommend reading up on.
As you’ve probably already seen, our new sidebar is finally live too! We have given it a facelift and different levels which we hope make it easier for you to navigate. All the content is where it used to be. Check it out (and let us know what you think)! You might also wonder where the tables following our code examples have gone. We have made them expandable, and given them a facelift as well.
We have also added 3DS2 test data, along with smaller maintenance tasks and bug fixes.
Version 3.1.8
Bigger things are coming up around the bend, so we are stopping by with some smaller fixes and a Digital Payments matrix giving you a better overview over which payment methods v3 has to offer, and the countries they are available.
We’ll be back soon!
Version 3.1.7
We kick off the new year with a new field in our payment order request. Your Digital Payments implementation of choice is now added in the request. Version 2 of the balance report and transaction list is our second newcomer this release. Head over to Settlement & Reconciliation to learn more.
We have added a paid status model to Checkout v2 and Payment Menu v2, and the update payment order section is added to Digital Payments.
Version 3.1.6
Our last update in 2022 mainly consists of clean-ups and fixes, but the most
important changes are bin
and msidn
fields added (where they are relevant)
to Paid resource model
and Paid status model, plus a small rework of
Age restrictions.
Happy holidays, everyone! We look forward to seeing you in 2023!
Version 3.1.5
Our penultimate release of the year has a few things up its sleeve. The most exciting being the new capabilities Integrated Commerce, Automated Fuel Dispenser Payments, SSN and Age restrictions. We’ve also added some new fields in the Paid and Cancelled models, a new Payer resource model. Please note the organization number added to the essential information for Checkout v3 set ups. Apart from that, there are no releases without typo corrections and bug fixes.
Version 3.1.3
Another small one. We’ve added Digital Payments paid
responses for all
methods in both status and
resource-models, finished up the headers which was missing,
added MobilePay to Request Delivery Information
and done away with some more bugs and typos.
Version 3.1.2
We have been picking up steam since our summer break, hitting full throttle as September arrived. A smaller release this time around, but there are some important additions nonetheless. We have added a siteID field to Digital Payments implementations, re-worked nearly all headers across the portal to make navigation easier, added a section on deleting payment tokens, along with the usual batch of assorted bug fixes and typos.
Version 3.1.1
A release filled with leftovers before we clock out for summer. Mostly small fixes in code examples and tables, but the most important additions are the new fields added in the paid resource model. Have a great summer!
Version 3.1.0
Summer has finally arrived, and we have quite a treat waiting in our final release before the vacation pulse kicks in. Without further ado: We now proudly offer Apple Pay! It is available in all our Digital Payments implementations and integrations. There are a couple of other new additions as well:
- Our SDKs have been updated to support Digital Payments
- You can now request delivery information for selected methods
- An eligibility check eligibility check for wallets has been added to instrument mode
- Fixed typos, minor bugs and code examples
Version 3.0.3
- Added a new card error code and restructured the tables.
- Fleshed out the Unscheduled Purchase section.
- Fleshed out the Recur section.
- Moved the callback section to core features.
- Typos and minor bug fixes in code examples and tables.
Version 3.0.2
- Typos and minor bug fixes in code examples and tables.
- Re-wrote Payer Aware Payment Menu
- Clarified
OnAborted
Seamless View event - Elaborated user agent fields in requests.
- Added links to resource models in Digital Payments response tables
Version 3.0.1
- Added descriptive card icons
- Added Payer Aware Payment Menu
- Added new screenshots for Digital Payments implementations
- Rewrote instrument mode section
- Reorganized features in the sidebar
- Fixed internal links
Version 3.0.0
It’s been a minute, but the day is finally here. We can proudly present Checkout version 3.0! The same range of payment methods, checkin options and features as always, but since different merchants have different needs, we’ve made it easier for you to get the checkout experience which fits you best. So, what’s new?
- Two Checkout implementations tailor-made for different needs and wishes: Enterprise or Payments Only. We’ve summed them up to help you find the right fit and get started.
- Each implementation starts off with a guide to set up your test account quickly.
- Want to see the new implementations in action? Head over to the demoshop.
- The Seamless View events have been re-worked to make the integration smoother for you.
- Renamed and gathered the Post-Purchase options on one page. The rest of the features are still where they used to be.
- We’ve given the front page a touch up, and given the new sections a slightly different look to distinguish them.
- Already up on Checkout version 2.0? No worries. All the documentation is still available in the sidebar and here.
Version 2.2.3
- Updated Android SDK documentation
- Added info about consumerProfileRef expiration
- Added important information about WebView integrations for mobile card payments
- Updated iOS SDK documentation
- Added information about authorization timeouts (bottom of page)
- Added important info about MobilePay shoplogoUrl
- Fixed minor bugs and code examples
Version 2.2.2
- Added payment link for Payment Menu v2
- Renamed Merchant Authenticated Consumer section (previously Delegated Strong Authenticated Consumer)
- Updated Unscheduled Merchant Initiated Transaction
- Fixed typos, minor bugs and code examples
Version 2.2.1
- Added payment link option for Trustly
- Added information about invoice capture in Checkout v2 and Payment Menu
- Added MobilePay
shoplogoUrl
in the Checkout v2 and Payment Menu v2 items section - Added Delete Token section in Card’s technical reference
- Fixed minor typos and bugs
Version 2.2.0
- Restructured Features sections for all implementations into core features, optional features and technical reference
- Renamed Checkout to Checkout v2
- Added TRA exemption section
- Fixed a handful of typos and bugs
Version 2.1.2
- Updated Theme version to 1.9.9
- Updated Design Guide Version to 5.0.1
Version 2.1.0
- Updated theme with visual fixes
- Search icon is now clickable
- Various bug fixes
- Various corrections and typo fixes
- Re-worded split settlement
- Clarified that callback is a fail-safe
- Updated tables and code examples with payerReference in various places, like card purchase
- Updated Mobile SDK configurations for both iOS and Android to include integration with custom backends
- Updated GitHub references for Mobile SDK
- Re-wrote Prices section
Version 2.0.2
- Various bug fixes
- Various corrections and typo fixes
- Corrected information about 3D-Secure
- Added paragraphs about different consumer flows in Checkin
- Added link to gift card on the front page
Version 2.0.1
- Added section for MobilePay Seamless View
- Split MobilePay Capture to a separate page
- Code examples for digital products added in Checkin
Version 2.0.0
Launched new developer portal theme:
- New design
- New menu structure
- Reading time
Other changes:
- Added GDPR disclaimer.
- Added custom 404 page.
- Added section about Transaction On File
- Added Seamless View for Trustly.
- Added documentation about payment and transaction states. See Card Other Features for example.
- Added event override warning for Seamless View Events, see Card Seamless View Events for example.
- Added section regarding MOTO in Card Other Features.
- Deleted Merchant Identified Payer in Checkout.
- Renamed Merchant Authenticated Consumer to Delegated Strong Customer Authentication.
- Updated
payer
/consumer
/end-user
naming for most sections. - Updated expiry date for test cards in test data.
- Updated callback documentation.
- Updated regex pattern for
orderItems.class
.
Version 1.13.3
- Added documentation on deprecated operations in Checkout.
- Updated
instrument
description in Checkout. - Updated
payeeReference
description. - Clarified
msisdn
andshoplogoUrl
in MobilePay Online Payments. - Updated Test data.
- Documented problems in Trustly Payments.
- Added an alert for two-phase payments in Capture pages.
Version 1.13.2
- Added description on
metadata
for all payment methods. - Updated files in Settlement & Reconciliation.
- Added information on token deletion in Card Payments and Invoice Payments.
- Updated the documentation on
paymentRestrictedToAgeLimit
andpaymentRestrictedToSocialSecurityNumber
in Swish Payments. - Added documentation on guest checkout in Checkout.
- Updated information about
logourl
in Checkout. - Added a list of accepted banks in Trustly Payments.
- Updated the
UpdateOrder
description in Checkout.
Version 1.13.1
- Removed documentation for Trustly Payments Seamless View.
- Updated
reOrderPurchaseIndicator
description. - Updated Other Features in Trustly Payments.
- Updated Test Data for Vipps Payments.
- Added updated documentation on the
transaction
operation.
Version 1.13.0
- Added documentation on Mobile SDK in Modules & SDKs section.
- Added tables for mapping API fields to settlement files in Settlement and Reconciliation.
Version 1.12.1
- Corrected the documentation by removing
generatePaymentToken
andpaymentToken
from Checkout.
Version 1.12.0
- Added information on 3-D Secure 2 for Checkout and Card Payments.
- Updated reconciliation files in Settlement & Reconciliation.
- Added test card for Forbrugsforeningen in Test data.
- Documented
paid
,failed
andaborted
across all resources. - Added additional information on
payerReference
,generateRecurrenceToken
,paymentToken
,generatePaymentToken
,recurrenceToken
andinstrument
for thepaymentorder
resource in Checkout. - Corrected and updated
view-
operations for all resources. - Updated Seamless View Events for all resources.
- Described
nonPaymentToken
andexternalNonPaymentToken
in Card Payments. - Small corrections to Swish Payments documentation.
- Clarified the
updateOrder
documentation.
Version 1.11.1
- Added additional information on the settlement files in Settlement & Reconciliation for all Payments.
- Corrected Card Payments Redirect and Card Payments Seamless View sequence diagrams.
- Added Abort in Swish Payments.
Version 1.11.0
- Added a new Trustly Payments section.
- Added information about Storing URLs in the Technical Information section.
Version 1.10.1
- Updated Swish Redirect requests.
- Added
orderReference
information in Payment Order Callback in Checkout Other features.
Version 1.10.0
- Added a new gift card section with descriptions of our Gift Cards API.
- Added a new section Co-badge Card Choice for Dankort in Card Payments.
Version 1.9.2
- Corrected table in payments page.
Version 1.9.1
- Corrected sequence diagrams in Swish Payments and Vipps Payments.
- The
description
field is now more thoroughly described for all requests it’s present in. - The
language
field is now better described for all requests it’s present in. - All broken links should now be unbroken.
Version 1.9.0
- Added a new section SDKs and Modules in Resources.
- Corrected problem
type
URLs for Card Payments, Checkout and Swish Payments. - Required checkmarks have a new, fresh look: check
- Flags now also sport a new look:
Version 1.8.3
- Bug fixes to Mermaid diagram and alert styling, plus improvements to code block styling after the update to Swedbank Pay Design Guide 4.5.0.
- Added examples with screenshots of the effects of Delegated Strong Customer Authentication.
Version 1.8.2
- Added a more thorough description on
paymentUrl
andcompleteUrl
in all relevant payments. - Updated
orderItems
to be required in all requests and responses. - Clean up of Swish Payments
- Removed
pageStripDown
in Vipps Redirect. - Updated the main page to be more welcoming.
- Updated information on Delegated Strong Customer Authentication.
Version 1.8.1
- Documented allowed characters in
orderItem.class
. - Added
receiptReference
in Invoice Payments and Payment Order in capture and reversal. - Callback is now moved to Other features in all payments methods.
- Clean up of MobilePay.
- Corrected the address of Leia Ahlström in Test Data.
- Updated the documentation in Card Payments
to recommend using
shippingAddress
. - Updated
payeeReference
to have an unique description for Payment Order and every Payment Method.
Version 1.8.0
- Updated Invoice Payments Direct where
approvedLegalAddress
should now be use for all countries. - Small text changes and clarifications.
- Restructured Invoice Payments and Card Payments.
Version 1.7.7
This change contains build updates for the page. :octocat:
Version 1.7.6
- Several links has been corrected. The chance of 404 is now much lower.
- Other small text changes and clarifications.
Version 1.7.5
- New page! Technical reference into has been moved from the front page to technical information.
- Front page got a slimmer look.
- Abort reference is back in credit card reference.
- Swish error code reference got a face lift, check it out here .
Version 1.7.4
- Described the M-Commerce flow for Swish Direct.
- Alphabetize the terms in Terminology.
Version 1.7.3
- Expanded information about the field
restrictedToInstruments
. - Added information about the field
receiptReference
. - Added and fixed several missing headings in template files.
- Expanded information about
verify
. - Created new page for Checkout Capture.
- Mobile Pay Online was previously only referred to as Mobile Pay, this has been corrected.
Version 1.7.2
- Removed several duplicate headers in features pages.
- Added unscheduled purchase information in card payments.
- We have added card logos when selecting card in payment menu. See updated screenshot of payment menu.
Version 1.7.1
All sections have been released.
Version 1.7.0
- README is updated with info about includes.
- Added several includes.
- Updated payeeReference description in Checkout and Invoice section.
- Using snake case consistently.
- Added section for unscheduled purchase in Card section.
- Fixed JavaScript example in Checkin section.
- Added info about mobile verification in Swish Other Features.
- Added section about Authenticated Merchants in Checkout section.
- Cleanup in
Vipps
Other Features. -
paymentRestrictedToAgeLimit
andpaymentRestrictedToSocialSecurityNumber
added toswish
object in Swish Redirect.paymentAgeLimit
,socialSecurityNumber
added to the newpayerInfo
object in Swish Seamless View. Properties added inSwish
. - Added section about migration key in Resources section.
Version 1.6.3
-
restrictedToInstruments
added back to Payment Order purchase requests. -
Direct Debit
section and mentions in various includes removed. - Various improvements and fixes.
Version 1.6.2
- The Payments and Card Payments sections are reviewed and released.
Version 1.6.1
-
email
,msisdn
,workPhoneNumber
andhomePhoneNumber
added to thepayer
object in Payment Order requests. -
cardholder
added to Card Payments Purchase requests. - Various improvements and fixes.
Version 1.6.0
- The Swish Payments and Vipps Payments have received a few updates and are now ready for another round of review.
- MobilePay Online Payments is now ready for review.
-
paymentAgeLimit
is now added in Swish Payments. - The Terminology page is updated and 3-D Secure 2.0 (3DS2) , PSD2 and SCA explanations are added.
- Added descriptions for Payment States And Transaction States everywhere appropriate.
- Google Analytics has been added to Developer Portal.
Version 1.5
- The review of Invoice Payments is complete and as such the section is now released and ready for use.
- The Card Payments section has received an overhaul, inching it closer to release.
- The Swish Payments and Vipps Payments sections are ready for review.
Version 1.4
- Updated Swish Redirect and Swish Direct sections in preparations for review and the transition from PayEx Developer Portal.
- Added Data Protection section.
- Payment Orders now support
orderItems
in all operations. - Added Terminology page.
- Clarified what the
awaitingActivity
state means for different payment methods. - Removed erroneous
noCVC
in examples for One-Click Card Payments section. - Added description for the
onBillingDetailsAvailable
event in the Checkin Front End section.
Update in checkin module
We have added support for specifying language as input in checkin module,
language
. Supported languages are Norwegian, Swedish and English. Consumers
outside Sweden and Norway can now purchase in our Checkout service. You can
specify supported countries for shipment in a new input parameter,
shippingAddressRestrictedToCountryCodes
, in our checkin module.
Updated API specification can be found here.
The parameters language
and shippingAddressRestrictedToCountryCodes
have replaced the former consumerCountryCode
.
The parameters msisdn
and email
have been made obsolete due to GDPR rules. This information cannot be sent in without the explicit consent of the payer.
Welcome, Swedbank Pay Developer Portal
PayEx’ Commerce offerings are being rebranded to Swedbank Pay and as a result of that rebranding, PayEx Checkout is now known as Swedbank Pay Checkout and its documentation can be found on here.
Support international phone numbers in Swish
We have added support for sending in international phone numbers in the request. Check our Swish documentation here. This is supported in API, and when payer’s enter their phone number on the payment page.
Order Items
The input parameter quantity
in the orderItems
field is now updated to decimal.
You may send up to 4 decimals. See updated documentation
here
Payment Url Credit Card
We have added the URL field called paymentUrl
for Card
Seamless View (previously added for Vipps and Checkout), that will be used
when the user is returned from 3rd party. The URL should represent the page in
where the payment Seamless View was hosted originally, such as the checkout page,
shopping cart page, or similar. Basically, paymentUrl
should be set to the
same URL as that of the page where the JavaScript for the hosted payment view
was added, in order to initiate the payment. Please note that the paymentUrl
must be able to invoke the same JavaScript URL from the same Payment as the one
that initiated the payment originally, so it should include some sort of state
identifier in the URL. The state identifier is the ID of the order, shopping
cart or similar that has the URL of the Payment stored. When the JavaScript is
invoked after return of the payer, they will either be redirected to
the completeUrl
(event onPaymentCompleted) or if payment has failed, see an
error-message and get the option to retry the payment.
Order Items in payment orders
On Payment Orders,
itemDescriptions
and vatSummary
has been replaced with the more
versatile and powerful orderItems
. While itemDescriptions
will continue
to work, it is recommended that all integrations switch over to orderItems
as soon as possible. When orderItems
is used, itemDescriptions
must be
removed from all requests as the two cannot be used simultaneously.
Payment Url
For our Seamless Views (currently Vipps or in
Checkout), we have added a new URL field called
paymentUrl
that will be used when user is returned from 3rd party. The URL
should represent the page of where the payment seamless view was hosted
originally, such as the checkout page, shopping cart page, or similar.
Basically, paymentUrl
should be set to the same URL as that of the page where
the JavaScript for the hosted payment view was added to in order to initiate the
payment. Please note that the paymentUrl
must be able to invoke the same
JavaScript URL from the same Payment or Payment Order as the one that initiated
the payment originally, so it should include some sort of state identifier in
the URL. The state identifier is the ID of the order, shopping cart or similar
that has the URL of the Payment or Payment Order stored. When the JavaScript is
invoked after return of the payer, they will either be redirected to the
completeUrl
, or, if payment failed, see an error message and get the option
to retry the payment.
If paymentUrl
is not implemented, retry of payments will not be possible in
either individual payment methods such as Vipps
or in Checkout. It makes it more tedious to retry payment as
the whole process including the creation of the payment or payment order needs
to be performed again. With paymentUrl in place, the retry process becomes much
more convenient for both the integration and the payer.