All notable changes to the API.

update: Add support for new payment type bambora.googlepay

• POST /v1/admin/sessions
• POST /v1/admin/sessions_profile
• POST /v1/admin/session/profiles
• GET /v1/admin/session/profiles/{profile_id}
• PUT /v1/admin/session/profiles/{profile_id}
• POST /v1/view/{session_id}/payments/bambora.googlepay

update: Add support for includes=event.success.true to only include successful events in transaction response

• GET /v1/transactions/{id}
• GET /v1/transactions

update: Add support for defining opening_hours and website_url in pick_up_address for a shipping option

• POST /v1/sessions
• POST /v1/sessions-profile

update: Add support for new payment type bambora.applepay

• POST /v1/admin/sessions
• POST /v1/admin/sessions_profile
• POST /v1/admin/session/profiles
• GET /v1/admin/session/profiles/{profile_id}
• PUT /v1/admin/session/profiles/{profile_id}
• POST /v1/view/{session_id}/payments/bambora.applepay

update: Add support for pay_in_store.type=full in shipping_option to enable pay during pick-up.

• POST /v1/sessions
• POST /v1/sessions-profile

update: Add support for order_store_id_as_order_payout_destination_id dynamic_payout_destination_ids type to support auto selecting payout_destination_id to be equal to the order store id

• POST /v1/admin/sessions/profiles

update: Make the social_security_number for collector.invoice and collector.installment optional for the pay endpoint. The property is not needed for payments where BankId is required

• POST /v1/sessions/{session_id}/pay

update: Update request body validaton for set gift card endpoint to only require pin if type is set to dintero.wallets.card_token.

• PUT /v1/view/{session_id}/session/order/gift_cards

new: Add payment operation pay-bambora-creditcard-cit, using Bambora CIT token to get card info.

• POST /v1/sessions/{session_id}/payments/bambora.creditcard

new: Add support for creating session with Bambora payment token.

• POST /v1/sessions
• POST /v1/sessions-profile

new: Add support for paying with Bambora CIT token

• POST /v1/sessions/{session_id}/pay

new: Add new session intent endpoint with support for poll_initiated

• POST /v1/events/session/{intent}

new: Document unsupported payment methods for Dintero gift cards.

• POST /v1/sessions-profile
• POST /v1/sessions

2024-07-01

update: Add intent type extend_authorization to events intent endpoint

• POST /v1/events/transaction/{intent}

update: Define gift_cards for session orders

• POST /v1/sessions-profile
• POST /v1/sessions
• GET /v1/sessions
• PUT /v1/sessions/{session_id}
• GET /v1/sessions/{session_id}
• GET /view/{session_id}/session
• POST examples/shipping_address_callback_url
• POST examples/session_url_callback

update: Remove optional transaction properties in events intent endpoint

• POST /v1/events/transaction/{intent}

update: Fix enums for card.type

update: Fix enums for event.metadata.vipps:transactionInfo.status Add enum values that was missing: SALE, Captured, Cancelled and Refund

update: Add transaction event error type and error_code to token transactions

• POST /v1/sessions/pay
• GET /v1/transactions/{id}

update: Add new transaction event type, INITIATE_VOID

• GET /v1/transactions/{id}

update: Extend card type for Bambora transactions with Debit and Credit. Deprecating the use of Credit Card as card type

update: Extend card with region for Bambora transactions and normalize the brand to be one of MasterCard or Visa

update: Adds additional configuration options to sessions and profiles for default_customer_type and allow_different_billing_shipping_address.

• POST /v1/sessions
• POST /v1/session_profile
• POST /v1/admin/sessions/profiles

new: Support adding payment information events to sessions

• POST /v1/view/{session_id}/session/events/payment_information

new: Add optional thumbnail_url to shippping_option to be shown in checkout.

• POST /v1/sessions-profile
• POST /v1/sessions
• GET /v1/sessions
• PUT /v1/sessions/{session_id}
• GET /v1/sessions/{session_id}
• GET /view/{session_id}/session
• POST examples/shipping_address_callback_url
• POST examples/session_url_callback

new: Support authorization callback from Klarna

• POST /v1/{session_id}/klarna/callback/{callback_ref}

new: Support void, capture, and refund for Dintero PSP transactions

• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/void
• POST /v1/transactions/{id}/refund
• GET /v1/transactions/{id}

new: Extend payout configuration to support dynamic_overrides to support using the order.store.id to set order.payout_destination_id. The new option enables existing integration that use order.store.id to start using payout with order.payout_destination_id set

• POST /v1/session
• POST /v1/session-profile
• POST /v1/admin/session/profiles
• PUT /v1/admin/session/profiles/{profile_id}

update: Allow splits to be empty when creating a payment session. A transaction created from session with empty items/shipping_option splits will require splits to be specified when capture or refund is performed.

• POST /v1/session
• POST /v1/session-profile

update: Transactions can be filtered by customer_id

• POST /v1/transactions

new: Add support for Dintero-Feature-Toggles header when updating session

• PUT /v1/sessions/{session_id}

new: Add full support for configuring an Express checkout session or profile with custom checkboxes.

• POST /v1/session
• POST /v1/session-profile
• POST /v1/admin/session/profiles
• PUT /v1/admin/session/profiles/{profile_id}
• PUT /v1/view/{session_id}/session/order/addresses

new: Support finish authorizing dintero_psp.creditcard and handle redirect

• POST /v1/sessions/{session_id}/pay
• POST /v1/sessions/{session_id}/dintero_psp/redirect/{redirect_ref}

new: Support getting payment operations for dintero_psp.creditcard

• POST /v1/view/{session_id}/payments/{payment_product_type}

new: Support dintero_psp.creditcard payment configuration

• PUT /v1/admin/checkout
• POST /v1/admin/session/profiles

new: Add support for using Dintero Wallets card to partly/fully authorize the payment session

• POST /v1/sessions
• POST /v1/sessions-profile
• PUT /v1/view/{session_id}/session/order/gift_cards
• POST /v1/sessions/{session_id}/pay

update: Add optional query param, email, to View Payment Operations

• POST /v1/view/{session_id}/payments/{payment_product_type}

add: Support specifying bambora_token_scope in bambora.creditcard payment options

• PUT /v1/admin/checkout

update: Add klarna.billie payment option

• POST /v1/view/{session_id}/payments/{payment_product_type}
• POST /v1/sessions
• POST /v1/sessions/{session_id}/pay
• POST /v1/admin/session/profiles
• PUT /v1/admin/session/profiles/{profile_id}
• PUT /v1/admin/checkout

update: Add Visa Tokenization credentials to Dintero PSP gateway.

• PUT /v1/admin/gateways/dintero
• GET /v1/admin/checkout

new: Add partial support for configuring an Express checkout session with custom checkboxes.

• POST /v1/session
• POST /v1/session-profile
• POST /v1/admin/session/profiles
• PUT /v1/admin/session/profiles/{profile_id}

new: Add support bambora tokenization Set token_scope and token_api_url on gateway configuration(prerequisite) Request payment(MIT) or recurrence(CIT) token on zero and non-zero amount session Use payment or recurrence token on payment to perform MIT or CIT

• PUT /v1/admin/gateways/bambora
• POST /v1/sessions
• POST /v1/sessions/payment-token
• POST /v1/sessions/pay

new: Add support for zero amount sessions by introducing new configuration option configuration.dintero.zero.enable. With the new option enabled a zero order session can be created, authorized, captured, refunded and voided. It make it possible to create express session to capture customer information via express without require any payment authorization by the customer.

• POST /v1/session-profile
• POST /v1/transactions/{id}/capture
• PUT /v1/admin/checkout
• GET /v1/sessions/{session_id}/dintero/redirect/{redirect_ref}

new: Add support for extending transaction authorization

• POST /v1/transactions/{id}/authorization

new: Add Dintero PSP gateway

• GET /v1/admin/checkout
• PUT /v1/admin/gateways/psp

new: Add support for the Klarna EMD marketplace orders package.

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add full support for the Klarna EMD travel-related transactions package (car rental reservation details).

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add partial support for the Klarna EMD travel-related transactions package (hotel reservation details).

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add partial support for the Klarna EMD travel-related transactions package (ferry reservation details).

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add partial support for the Klarna EMD travel-related transactions package (train reservation details).

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add partial support for the Klarna EMD travel-related transactions package (bus reservation details).

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add partial support for the Klarna EMD travel-related transactions package (air reservation details).

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add support for the Klarna EMD recurring payments package.

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add support for the Klarna EMD event package.

• POST /v1/session
• POST /v1/session-profile
• PUT /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

update: Deprecate endpoint in favor of PUT /v1/view/{session_id}/session/order/addresses

• PUT /v1/view/{session_id}/session/order/shipping_address

new: Add generate_payment_token to session.payment_operation.

• POST /v1/sessions/payment-token
• GET /v1/sessions?payment_operation=generate_payment_token

break: Remove ingenico completely, i.e. payment type, payment operation, checkout config, gateway setup.

• GET / POST /v1/events/gateways/ingenico/transaction/hooks
• GET /v1/sessions/{session_id}/ingenico/redirect/{redirect_ref}
• PUT /v1/admin/gateways/ingenico
• PUT / GET /v1/admin/checkout

break: Administration of checkout gateways will no longer be supported via the scope admin:checkout and will require admin:dintero. This affects the following endpoints:

• PUT /v1/admin/gateways/bambora
• PUT /v1/admin/gateways/collector
• PUT /v1/admin/gateways/collector/credentials
• PUT /v1/admin/gateways/collector/override
• PUT /v1/admin/gateways/ingenico
• PUT /v1/admin/gateways/instabank
• PUT /v1/admin/gateways/klarna
• PUT /v1/admin/gateways/klarna/credentials
• PUT /v1/admin/gateways/netaxept
• PUT /v1/admin/gateways/netaxept/override
• PUT /v1/admin/gateways/payex
• PUT /v1/admin/gateways/payex/credentials
• PUT /v1/admin/gateways/payex/override
• PUT /v1/admin/gateways/santander
• PUT /v1/admin/gateways/santander/override
• PUT /v1/admin/gateways/swish
• PUT /v1/admin/gateways/swish/override
• PUT /v1/admin/gateways/vipps
• PUT /v1/admin/gateways/vipps/override

new: Support payex.mobilepay through payex v3 when gateway_api_version is set to "payex.v3", and add payment operation for pay-payex-v3-mobilepay.

• PUT /v1/admin/checkout
• POST /v1/view/{session_id}/payments/payex.mobilepay

new: Support payex.googlepay payment product type.

• PUT /v1/admin/checkout
• POST /v1/session-profile
• POST /v1/view/{session_id}/payments/{payment_product_type}

new: Add support for appswitch deeplink URL for payex.mobilepay sessions with channel=in_app set.

• POST /v1/session
• POST /v1/session-profile

new: Support payex.vipps through payex v3 when gateway_api_version is set to "payex.v3", and add payment operation for pay-payex-v3-vipps.

• PUT /v1/admin/checkout
• POST /v1/view/{session_id}/payments/payex.vipps

new: Support payex.swish through payex v3 when gateway_api_version is set to "payex.v3", and add payment operation for pay-payex-v3-swish.

• PUT /v1/admin/checkout
• POST /v1/view/{session_id}/payments/payex.swish

update: Require locale for initiating checkout payment for klarna.klarna.

• POST v1/sessions/{session_id}/pay

update: Add string representation of order to response from view payment operations for klarna.klarna

• POST /v1/view/{session_id}/payments/klarna.klarna

new: Support payex.clicktopay payment type. Extend configuration on gateway and session to enable Click to Pay.

• PUT /v1/admin/checkout
• POST /v1/session-profile
• POST /v1/view/{session_id}/payments/{payment_product_type}

new: Add version to session

• POST /v1/view/{session_id}/payments/{payment_product_type}
• GET /v1/view/{session_id}/session
• PUT /v1/view/{session_id}/session/order/addresses
• PUT /v1/view/{session_id}/session/order/discount_codes
• PUT /v1/view/{session_id}/session/order/shipping_address
• PUT /v1/view/{session_id}/session/order/shipping_option

update: Also accept version property as If-Unmodified-Since to initiaite checkout payment.

• POST /v1/view/{session_id}/pay

update: Limit refund to positive amount

• POST /v1/transactions/{id}/refund

new: Add support for finishing authorization of Klarna payment and handle redirect.

• POST /v1/sessions/{session_id}/pay
• POST /v1/sessions/{session_id}/klarna/redirect/{redirect_ref}

update: Add support for marketing_consent when initiating Instabank payment

• POST /v1/sessions/{session_id}/pay

update: Add support for query_gateway query parameter when getting status of PayEx payment for a session.

• GET /v1/view/{session_id}/payex/{payment_id}/status

new: Support payex.applepay payment product type. Extend configuration on gateway and session to enable Apple Pay.

• PUT /v1/admin/checkout
• POST /v1/session-profile
• POST /v1/view/{session_id}/payments/{payment_product_type}

new: Add support for getting payment operations for Klarna

• POST /v1/view/{session_id}/payments/{payment_product_type}

new: Add support for enabling Klarna payment when creating payment sessions

• POST /v1/sessions-profile
• POST /v1/sessions
• POST /v1/admin/session/profiles
• PUT /v1/admin/session/profiles/{profile_id}
• PUT /v1/admin/checkout

new: Add support for configuring Klarna gateway

• PUT /v1/admin/gateways/klarna
• PUT /v1/admin/gateways/klarna/credentials

update: Include Klarna gateway and credentials details

• GET /v1/admin/checkout

update: Update Payex transaction. Extend card.type with Debit Card, and let metadata.payex:payment:number and event.metadata.payex:transaction:number be either string or number.

• GET /v1/transactions
• GET /v1/transactions/{id}

update: Add support for strict-success-merchant-reference Dintero-Feature-Toggles header when creating merchant initiated session. The new flag allow "duplicates" if existing sessions failed

• POST /v1/sessions/pay

new: Add endpoint for handle callback for payex V3 payments

• POST /v1/sessions/{session_id}/payex-v3/callback/{callback_ref}

new: Add endpoint for handle redirect for payex V3 payments

• GET /v1/sessions/{session_id}/payex-v3/redirect/{redirect_ref}

update: Add support for pay-payex-v3-creditcard payment operations response from endpoint

• POST /v1/view/{session_id}/payments/{payment_product_type}

update: Add support for specifying gateway_api_versions when configuring payment options

• PUT /v1/admin/checkout
• GET /v1/admin/checkout

update: Add suport promiting credential to gateway and gateway override The new option add support for configuring gateway and overrides when credential is created or updated

• PUT /v1/admin/gateways/collector/credentials
• PUT /v1/admin/gateways/payex/credentials

new: Add endpoint for managing credentials for Collector gateway

• PUT /v1/admin/gateways/collector/credentials

new: Add endpoint for managing credentials for PayEx gateway

• PUT /v1/admin/gateways/payex/credentials

new: Add support for appswitch deeplink URL for payex.vipps sessions with channel=in_app set.

• POST /v1/session
• POST /v1/session-profile

new: Add support for including metadata about discounts via discount_lines when capturing or refunding a transaction.

• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add metadata.payout property to transaction, the new property will be set if payout is enabled and state what kind of payout will be done

• GET /v1/transactions/{id}

change: Extend support for void on part capture. Void can now be used to release remaining authorization on part captured payex.mobilepay and payex.vipps transactions

• POST /v1/transactions/{id}/void

new: Add possibility to change name of session_id query parameter in callback_url

• POST /v1/session
• POST /v1/session-profile
• POST /v1/sessions/pay

change: Improve endpoint for handle unscheduled and recurring payments

• Block pay request with duplicate merchant_reference
• Include session_id in error response, to use to check status on failure
• Add payment_operation to session / transaction that state the intent with the payment session was, e.g. unscheduled_purchase or recurring_purchase
• POST /v1/sessions/pay
• GET /v1/sessions/{session_id}
• GET /v1/transactions/{id}

change: Add support for void on part capture Vipps transaction. Void can be used to release the remaining authorization on a part captured transaction.

• POST /v1/transactions/{id}/void

new: Add strict mode header to validate correct session amounts

• POST /v1/session
• POST /v1/session-profile

new: Add support for payout splits via Dintero Payout

• POST /v1/session-profile
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund

new: Add item types to distinguish between physical and digital items, and a category for services

new: Add thumbnail url to order item to be shown in checkout

• POST /v1/sessions-profile
• POST /v1/sessions
• PUT /v1/sessions/{session_id}

new: Add possibility to update session without locking it first

new: Add possibility to update session.express

• PUT /v1/sessions/{session_id}

new: Document support for recurring payments. Extend configuration to support generating recurring payment token for payex.creditcard payments and performing recurring payments via the pay endpoint

• POST /v1/sessions/pay
• POST /v1/sessions-profile
• POST /v1/sessions
• POST /v1/transactions/{id}

new: Add shipping_mode to decide if a shipping option is required

• POST /v1/sessions-profile
• POST /v1/sessions

fix: Require description when creating session profile. Document that description is a required property for session profile. The property has always been required by the service.

• POST /v1/admin/session/profiles
• PUT /v1/admin/session/profiles/{profile_id}

new: Support payex.mobilepay payment product type. Extend configuration on gateway and session to enable MobilePay payment via PayEx PSP service.

• PUT /v1/admin/checkout
• POST /v1/session-profile
• POST /v1/sessions/{session_id}/pay
• POST /v1/view/{session_id}/payments/{payment_product_type}

new: Document event_id query parameter included in request sent to session callback_url

• POST /v1/sessions-profile
• GET /exaples/session_url_callback

new: Store initiating system request headers on session and transaction. Add ability to filter sessions on plugin name.

• GET /v1/sessions/{session_id}
• GET /v1/transactions/{id}
• GET /v1/sessions

new: Add support for handle authorization redirect from Collector IdP

• GET /v1/events/gateways/collector/idp/signin

new: Add support for including authorization_code in Collector pay requests

• POST /v1/sessions/{session_id}/pay

change: Add ability to keep overrides for swish gateway PUT /v1/admin/gateways/swish

new: Add support for order.payout_destination_id when creating new sessions. The property will be included in the settlement reports and used if payout is enabled.

• POST /v1/sessions-profile
• POST /v1/sessions

new: Pay with payex.swish, support for both E-Commerce and M-Commerce Swish Payments.

• POST /v1/sessions/{session_id}/pay

change: Validate PayEx subsite, return 400 if invalid subsite is used

• PUT /v1/admin/gateways/payex
• PUT /v1/admin/gateways/payex/override

new: The profile_id used when creating new sessions will now be included in the session and transaction metadata.session:profile_id property

• POST /v1/sessions-profile
• GET /v1/sessions/{session_id}
• GET /v1/transactions/{id}

new: Support for configuring payout for payment products

• PUT /v1/admin/checkout

new: Support including events.request_headers when fetching session and transaction, and performing capture, refund or void on the transaction

• GET /v1/transactions/{transaction_id}
• GET /v1/sessions/{session_id}
• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund
• POST /v1/transactions/{id}/void

change: Add support for phone_number when getting payment operations

• POST /v1/view/{session_id}/payments/{payment_product_type}

change: Add support for payex.vipps payment product type

• POST /v1/view/{session_id}/payments/{payment_product_type}

new: Support payex.vipps payment product type. Extend configuration on gateway and session to enable Vipps payment via PayEx PSP service.

• PUT /v1/admin/checkout
• POST /v1/session-profile
• POST /v1/sessions/{session_id}/pay

new: Support bambora.mobilepay payment product type. Extend configuration on gateway and session to enable MobilePay payment via Bambora Wallet service. The payment type must be enabled by Bambora.

• PUT /v1/admin/checkout
• POST /v1/session-profile
• POST /v1/sessions/{session_id}/pay

doc: Fix documentation for payment-token session endpoint. session and payment_token are required when creating payment-token session.

• POST /v1/sessions/payment-token

new: Support enable_on_hold-configuration on session configuration and in checkout configuration

• POST /v1/session-profile
• POST /v1/sessions-profile
• POST /v1/sessions
• PUT /v1/admin/checkout

new: Support bambora.vipps payment product type. Extend configuration on gateway and session to enable Vipps payment via Bambora Wallet service. The payment type must be enabled by Bambora.

• PUT /v1/admin/gateways/bambora
• PUT /v1/admin/checkout
• POST /v1/session-profile
• POST /v1/sessions/{session_id}/pay

new: Support session profile configuration when creating payment-token session

• POST /v1/sessions/payment-token

new: Extend shipping_address_callback response with support for updating the checkout session in addition to returning available shipping options. This will allow the callback endpoint to update the content of the order, like changing amount, or currency or update the items in the order.

• POST /v1/sessions-profile
• POST /v1/sessions
• POST examples/shipping_address_callback_url

change: Add support for void on part capture. Void can be used to release the remaining authorization on a part captured transaction. The support is limited to payex.creditcard transactions.

• POST /v1/transactions/{id}/void

change: Add support for language query parameter when getting payment operations

• POST /v1/view/{session_id}/payments/{payment_product_type}

change: Add support Bambora creditcard payment.

• POST /v1/sessions
• POST /v1/sessions-profile

change: Add support for bypassing the Dintero redirect for in_app-payments, and redirect from app to app.

• POST /v1/sessions
• POST /v1/sessions-profile

change Add support for includes query parameter in session url.callback_url. includes set to session will enable the sessions url.callback_url to include session data in the body.

• POST /v1/sessions
• POST /v1/sessions-profile

new: It is now possible to use full ISO 8601 compliant datetimes in date range queries. Note: If timezone isn't specified, UTC is assumed Note: To keep things backwards compatible, end-dates with the "yyyy-mm-dd" format will be shifted forward by a day.

• GET /v1/transactions
• GET /v1/sessions

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

• POST /v1/view/{session_id}/session/order/addresses

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

• GET /v1/transactions/{id}

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

• POST /v1/transactions/events/payout

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

• PUT /v1/admin/gateways/payex
• PUT /v1/admin/gateways/payex/override

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

• GET /v1/sessions

new: Endpoint for initiating MIT payments

• POST /v1/sessions/pay

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

• POST /v1/sessions-profile
• POST /v1/sessions
• POST /admin/session/profiles

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.

• POST /v1/sessions-profile
• POST /v1/sessions
• POST examples/discount_code_callback_url

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

• POST /v1/creditchecks

new: Add support for overriding Collector gateway settings

• PUT /v1/admin/gateways/collector/override

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.

• POST /v1/transactions/{id}/capture
• POST /v1/transactions/{id}/refund
• POST /v1/transactions/{id}/void

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.

https://example.com/callback?report_event=CAPTURE&report_event=REFUND

• POST /v1/sessions-profile
• POST /v1/sessions

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

• POST /v1/sessions-profile
• POST /v1/sessions

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

• POST /v1/sessions-profile
• POST /v1/sessions

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

• POST /v1/sessions-profile
• POST /v1/sessions

new Add support for updating a session

• PUT /v1/sessions/{session_id}
• POST /view@{session_id}@session@lock

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

• POST /v1/sessions/pay

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

• POST /v1/sessions-profile
• POST /v1/sessions

new Add support for optional merchant_reference_2 when creating a new session

• POST /v1/sessions-profile
• POST /v1/sessions

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

https://example.com/callback?delay_callback=30

new: Add support for overriding Netaxept gateway settings

• PUT /v1/admin/gateways/netaxept/override

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

new: Add support for Netaxept.

• GET /view/{session_id}/netaxept

new: Add support for overriding PayEx gateway settings

• PUT /v1/admin/gateways/payex/override

new: Include payment token in transaction details

• GET /v1/transactions/{id}?includes=card.payment_token

new Added option for using payment token for payex.creditcard 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 payex.creditcard payments, see configuration.payex.creditcard. 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.

• PUT /v1/transaction/{transction_id}
• GET /v1/transactions

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

https://example.com/callback?method=POST

• POST /v1/sessions
• POST /v1/sessions-profile

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.

• POST /v1/sessions
• POST /v1/sessions-profile

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.

• POST /v1/sessions
• POST /v1/sessions-profile

change: Add support for creating session with Ingenico enabled

• POST /sessions-profile
• POST /sessions
• POST /admin/session/profiles

change: Add support for creating session with Ingenico enabled

• POST /sessions-profile
• POST /sessions
• POST /admin/session/profiles

new Add support for collector.invoice_b2b payment

new Add support for configuring Ingenico gateway

• PUT /admin/gateways/ingenico

new Add support for enabling Dintero-Signature header for all system-to-system request sent from Dintero to the merchant

• POST /v1/admin/signature

fix: Documentation for endpoint GET /v1/admin/api-keys. The resource returns a list of api-keys, not a single api-key.

new Add support for collector.installment payment

new Add support for putting merchant_terms_url in profile and session

• POST /v1/admin/session/profiles
• PUT /v1/admin/session/profiles/{profile_id}
• POST /v1/sessions
• POST /v1/sessions-profile

new Add support for overriding gateway settings

• PUT /v1/admin/gateways/vipps/override
• PUT /v1/admin/gateways/santander/override

new Add support for include_session query parameter

• POST /v1/sessions-profile
• POST /v1/sessions

new Add support for discount calculation on sessions. The discounts will be calculated when customer is identified

Extend the order and transaction items with new properties to support discount calculation of session:

• discount_lines
• gross_amount
• is_change
• eligible_for_discount

Support calculating and updating session with discount from:

• POST /v1/sessions-profile
• POST /v1/sessions

new Add store property to session.order and transaction. Adds support for including details about the sales location in the order

new Add shipping_option from session.order to to transaction

• GET /transactions
• GET /transactions/{id}

changed Minor changes to the shipping_option object(s) in sessions

• POST /v1/sessions
• GET /v1/sessions
• GET /v1/sessions/{session_id}
• GET /view/{session_id}/session

new Add an endpoint for abandon a checkout payment

• POST /view/{session_id}/session/abandon

changed: Express Checkout flow added to sessions

• POST /v1/sessions
• GET /v1/sessions
• GET /v1/sessions/{session_id}
• GET /view/{session_id}/session

new Update a an Express Checkout session order

• PUT /view/{session_id}/session

new: Extend Transaction with optional billing_address field.

new: Extend Transaction Event with correction field to handle correction of status after operations errors

changed: previously required fields are now optional for instabank.finance.

• mortgage_debt
• student_debt
• other_secured_debt

changed: Payments for payment product type instabank.invoice now contain an optional applicant object used for sending more details about the payee. The applicant data will be required for amounts over a limit specified by Instabank.

• POST /v1/sessions/{session_id}/pay

changed: Payment sessions with instabank.invoice now contains an require_applicant boolean flag in the instabank invoice configuration when getting the session.

• GET /v1/sessions/{session_id}

changed: Adds detailed debt array to instabank.finance.

changed: Disabled instabank.invoice for amounts less than 500 NOK

new: Filter transaction list by payment_product_type:

• instabank.finance
• instabank.invoice
• vipps
• payex.creditcard
• payex.swish

new: Filter transactions list by card_brand:

• Visa
• MasterCard

new: Added optional remember_me boolean to POST pay request body when initializing a payment of a session.

• POST /v1/sessions/{session_id}/pay

fix: Transaction.status typo, rename PARTICALLY_CAPTURED_REFUNDED to PARTIALLY_CAPTURED_REFUNDED.

changed: replaced card payment type with payex. The payex payment type adds support for payment product types:

• payex.creditcard
• payex.swish

changed: Add support for optional custom expires_at parameter when creating a new session either directly or from a profile.

• POST /v1/sessions-profile
• POST /v1/sessions

changed: Add support for override of configuration when creating a new session from a profile.

• POST /v1/sessions-profile

new: support cancel of session

• POST /v1/sessions/{session_id}/cancel

changed: In SessionBase, extend order with partial_payment property that can be used in case where the payment is partial and the order.amount is less or equal to the order.items.amount.

• POST /v1/sessions
• POST /v1/sessions-profile

break: Pay with instabank.finance type requires now additional properties to comply with new regulations from Finanstilsynet.

• POST /v1/sessions/{session_id}/pay changed: In SessionMeta events, extend event with details object and enumerate the event names available.
• GET /v1/sessions/{session_id}

changed: Remove instabank.installment and instabank.postponement payment type. The types will no longer be accepted by:

• PUT /v1/admin/checkout
• PUT /v1/admin/gateways/instabank
• POST /v1/admin/session/profiles
• POST /v1/sessions

In SessionMeta renamed field expiry_at to expires_at.

new: PaymentConfiguration extended with optional auto_capture boolean field. If set to true the checkout serivce will automatically capture the payment after the transaction is AUTHORIZED.

new: Add support for checkout with SMS. A SMS with link to the checkout can now be sent when a new session is created. See relevant resources for more information.

• POST /v1/sessions-profile
• POST /v1/sessions

fix: Fix documentation for the response from api-keys endpoints. No gateways property will be included in response to api-keys requests.

doc: Document support for JWT Bearer authentication. Use API client to get an JWT access token.

• Create Client
• Get token

break: Administration of checkout gateways was moved to new endpoints. Gateway configuration will no longer be supported via the PUT /admin/checkout endpoint.

• PUT /admin/checkout
• POST /admin/gateways/{gateway}/status
• PUT /admin/gateways/instabank
• PUT /admin/gateways/vipps

removed:

• POST /admin/gateways/{gateway} (check gateway status)

new: Extend transaction.event with created_by property. Include the user who created the event, i.e. applied an operation to the transaction.

new: Add support for checkout with QR-Code A QR Code can now be generated for a Checkout Session. See relevant resource for more information.

• POST /v1/sessions/{session_id}/qr

new: Add support for filter transactions with query parameters. Transactions can now be filtered on: status, payment_product, merchant_reference, session_id, amount and created_at.

• GET /v1/transactions

new: Add support for session.url.callback_url. Get system-to-system notification when session payment is completed.

• POST /v1/sessions-profile
• POST /v1/sessions

A Checkout Session relates to an order in your system. When an order has been placed you create a corresponding Checkout Session to receive payment for that order.