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.
01 Dec 2020
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
12 Nov 2020
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
11 Nov 2020
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 Consumer 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
.
04 Sep 2020
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 in Resources.
- Documented problems in Trustly Payments.
- Added an alert for two-phase payments in Capture pages.
28 Aug 2020
Version 1.13.2
- Added description on
metadata
for all payment instruments. - 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.
21 Aug 2020
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.
17 Jul 2020
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.
10 Jul 2020
Version 1.12.1
- Corrected the documentation by removing
generatePaymentToken
andpaymentToken
from Checkout.
07 Jul 2020
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.
04 Jun 2020
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.
29 May 2020
Version 1.11.0
- Added a new Trustly Payments section.
- Added information about Storing URIs in the Technical Information section.
22 May 2020
Version 1.10.1
- Updated Swish Redirect requests.
- Added
orderReference
information in Payment Order Callback in Checkout Other features.
14 May 2020
Version 1.10.0
- Added a new Gift Cards section with descriptions of our Gift Cards API.
- Added a new section Co-badge Card Choice for Dankort in Card Payments.
07 May 2020
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.
22 Apr 2020
Version 1.9.0
- Added a new section SDKs and Modules in Resources.
- Corrected problem
type
URIs for Card Payments, Checkout and Swish Payments. - Required checkmarks have a new, fresh look: check
- Flags now also sport a new look:
15 Apr 2020
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 Merchant Authenticated Consumer.
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 Card Payments Direct to have a correct integration flow.
- Updated the main page to be more welcoming.
- Updated information on Merchant Authenticated Consumer.
31 Mar 2020
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 intruments.
- 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 Instrument.
18 Mar 2020
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.
04 Mar 2020
Version 1.7.6
- Several links has been corrected. The chance of 404 is now much lower.
- Other small text changes and clarifications.
03 Mar 2020
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.
27 Feb 2020
Version 1.7.3
- Expanded information about the field
restrictedToInstruments
. - Added information about the field
receiptReference
. - Added information about direct integration in Credit card.
- 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 refered to as Mobile Pay, this has been corrected.
7 Feb 2020
Version 1.7.2
- Removed several duplicate headers in other-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.
6 Feb 2020
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.
29 Jan 2020
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.
27 Jan 2020
Version 1.6.0
- Credit Payments (née “Credit Account”) sections have been deleted from the Swedbank Pay Developer Portal.
- 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.
16 Jan 2020
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.
- The Direct Debit, MobilePay Online Payments and Credit Payments (née “Credit Account”) sections have received a few updates, inching them all closer to review.
09 Jan 2020
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 instruments. - Removed erroneous
noCVC
in examples for One-Click Card Payments section. - Added description for the
onBillingDetailsAvailable
event in the Checkin Front End section.
22 Dec 2019
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.
01 Nov 2019
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 OrderItems-node is now updated to decimal.
You may send up to 4 decimals. See updated documentation
here
01 Oct 2019
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, he or she 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.
01 Aug 2019
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 hosted 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, he or she 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 instruments 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.