Checkout API (LATEST)

API Integration Support: License: UNLICENSED


All notable changes to the API.


new: Add possibility to create myDintero-user in address change

new: Extend transaction data with embedded session data includes now supports 'session'

new: Extend Vipps transaction metadata with vipps:merchantInfo.merchantSerialNumber, the Merchant Serial Number (MSN) that was used when the transaction was initiated.

new Add support for setting settlements on a transaction, one event per payout to a bank account

new: Version support when updating PayEx gateway configuration. The new option allows the gateway to be configured with multiple merchant agreements

change: Add support for additional query parameters. search will match on merchant reference's and customer name transaction_id will filter results to include only sessions associated with the provided transaction ids created_at.gte will exclude all sessions created before provided date created_at.lte will exclude all sessions created after provided date


new: Endpoint for initiating MIT payments

new: Checkout sessions and profiles supports theming via configuration.theme


new: Add support for using external discount codes in Express checkout. A session can be configured with a express.discount_code_callback_url that will be invoked when the session is updated with a promotion code. The response from the callback will then be used to adjust the order and shipping options available.

new: Add support for an advance credit check of Collector B2B customers


new: Add support for overriding Collector gateway settings

new Add support for collector.invoice_b2b_preapproved and collector.installment_b2b_preapproved payment

new Async transaction operations. The response status from capture, refund or void can now be 202 if the request was accepted but the processing has not been completed.

The transaction with an operation that was accepted will receive a update later when the processing completes. The event that completes the operation will include an initiate_request_id property. You can use the callback_url to receive a callback when the processing completes.

The status of the transaction will remain unchanged until the processing of the operation completes.

new Add support for callback when transaction is updated. You can now receive callbacks on captures, refunds and void by including report_event=<event> query parameter in the callback_url.


new Added in_store as a possible payment channel for payments in physical stores.


new Added option for configurating the payment channel. See The new option add support for in_app channel with appswitch deeplink URL (Vipps).

new Add support for optional order.discount_lines when creating a new sessions.

new Add support for updating a session

total_income moved from applicant to top level for instabank.invoice and instabank.installment. The field is required, but there will be a grace period of two months before it is enforced. Deprecated applicant.total_income


new Add support for optional metadata when creating a new session.

new Add support for optional merchant_reference_2 when creating a new session

new Add support for delayed callback. You can enable the delay callback feature by including delay_callback=<seconds> query parameter in the callback_url


new: Add support for overriding Netaxept gateway settings

new: Add terminal options for Netaxept creditcard payment. Enable use of Netaxept hosted checkout, and provided custom configuration.

new: Add support for Netaxept.

new: Add support for overriding PayEx gateway settings

new: Include payment token in transaction details

new Added option for using payment token for payments to prefill payment details so the customer (payer) do not need to enter all these details for every purchase.

new Added option for generating payment token for payments, see Use the new option to generate a payment token that can be used in future payments to prefill the details for the creditcard.

new Added instabank.postponement payment type.

new Added swish.swish payment type, direct integration with Swish.


change Add support for ON_HOLD transaction status. The new status is limited to Collector transactions, to signal that the processing of the transaction is not yet completed. The new status will be used in cases where Collector performs aditional controls before approving the payment.

new Add support for setting merchant_reference_2 to an existing transaction and search for transactions by merchant_reference_2.


new Add support for POST callback with the authorized transaction included in the request body. You can enable the POST callback feature by including method=POST query parameter in the callback_url


new Add support for instabank.installment payment

changed: Removed error capture from list of valid error added to the redirect to the url.redirect_url. The error was used for payments with auto-capture enabled, and set in case where the auto capture failed. The merchant can assume the transaction will be captured automatically as soon as possible when creating a session with auto-capture enabled.

changed: A callback (when url.callback_url is set) will now be sent as soon as possible after the transaction is AUTHORIZED. We will no longer wait until the transaction CAPTURED in case when auto-capture is enabled.

change: Add support for creating session with Ingenico enabled

change: Add support for creating session with Ingenico enabled

new Add support for collector.invoic