Seamless View Events

Payment Menu Events

During operation in the Payment Menu, several events can occur. They are described below.

onApplicationConfigured

This event triggers whenever a reconfiguration leads to resizing of the payment menu. No action will be done if callback is not set. The onApplicationConfigured event is raised with the following event argument object:

onApplicationConfigured event object

Copy json to clipboard

1
2
3
4
5
6

{
    "actionType": "OnApplicationConfigured",
    "bodyHeight": "[clientHeight of iframe content]",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "source": "PaymentMenuCore"
}

onError

This event triggers during terminal errors or if the configuration fails validation. The onError event will be raised with the following event argument object:

onError event object

Copy json to clipboard

1
2
3
4
5
6

{
    "bodyType": "OnError",
    "details": "English descriptive text of the error",
    "origin": "paymentorders",
    "paymentOrderId:": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1"
}

onExternalRedirect

This event triggers when a user is redirected to a separate web page, like 3D-Secure or BankID signing.

Subscribe to this event if it’s not possible to redirect the payer directly from within Swedbank Pay’s payment frame.

If no callback method is set, you will be redirected to the relevant url. It will be raised with the following event argument object:

onExternalRedirect event object

Copy json to clipboard

1
2
3
4
5

{
    "actionType": "OnExternalRedirect",
    "paymentOrderId:": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "redirectUrl": "https://example.com/external"
}

onOutOfViewOpen

Triggered when another tab is opened in the browser, like the information page for onboarding of stored cards, or Swedbank Pay’s owner TOS.

The event cannot be opened as a modal since the payer needs to see that this is a link on Swedbank Pay’s domain.

Subscribe to this event if you do not want the default handling of these links. But e.g. want to redirect the payer to a new page, and not just another tab within the same browser.

If no callback method is set, the url will be opened in a new tab. It will be raised with the following event argument object:

onOutOfViewOpen event object

Copy json to clipboard

1
2
3
4
5

{
    "actionType": "OnOutOfViewOpen",
    "openUrl": "https://example.com/external",
    "paymentOrderId:": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1"
}

onPaymentCanceled

This event triggers when the payer aborts the purchase from the payment menu. As the Seamless View payment menu doesn’t have a cancel button (present in the Redirect integration), you need to provide this button for the payer at your end. When the payer presses the cancel button, we recommend sending an API request aborting the payment so it can’t be completed at a later time. When we receive the request, an abort event will be raised the next time the UI fetches information from the server. Because of that, you should also refresh after aborting, as this will trigger the event.

It will be raised with the following event argument object:

onPaymentCanceled event object

Copy json to clipboard

1
2
3
4
5
6

{
    "actionType": "OnPaymentCanceled",
    "id": "/psp/{instrument}/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "redirectUrl": "https://example.com/cancelled"
}

onPaymentCompleted

This event triggers when the payer successfully completes or cancels the payment.

Subscribe to this event if actions are needed on you side other than the default handling of redirecting the payer to your completeUrl. Call GET on the paymentOrder to receive the actual payment status, and take appropriate actions according to it.

It will be raised with the following event argument object:

onPaymentCompleted event object

Copy json to clipboard

1
2
3
4
5
6

{
    "actionType": "OnPaymentCompleted",
    "id": "/psp/{instrument}/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "redirectUrl": "https://example.com/success"
}

onPaymentCreated

Triggered when the payer has selected a payment method and actively attempts to perform a payment.

The onPaymentCreated event is raised with the following event argument object:

onPaymentCreated event object

Copy json to clipboard

1
2
3
4
5
6

{
    "bodyType": "OnPaymentCreated",
    "id": "/psp/{instrument}/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "instrument": "creditcard",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1"
}

onPaymentFailed

Triggered when a payment has failed, disabling further attempts to perform a payment.

The onPaymentFailed event is raised with the following event argument object:

onPaymentFailed event object

Copy json to clipboard

1
2
3
4
5
6

{
    "actionType": "OnPaymentFailed",
    "id": "/psp/{instrument}/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "redirectUrl": "https://example.com/failed"
}

onPaymentMenuInstrumentSelected

This event triggers when a user actively changes payment method in the Payment Menu.

Subscribe to this event if actions, e.g. showing an information text, are required on your side if the payer changes payment method.

If no callback method is set, no handling action will be done. It will be raised with the following event argument object:

onPaymentMenuInstrumentSelected event object

Copy json to clipboard

1
2
3
4
5

{
    "bodyType": "OnPaymentMenuInstrumentSelected",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "instrument": "creditcard | vipps | swish | invoice"
}

onPaymentPending

Triggered when a payment enters a paying state ( Sale, Authorize, Cancel, etc).

Read more about these events below.

onPaymentPending event object

Copy json to clipboard

1
2
3
4
5

{
    "bodyType": "OnPaymentPending",
    "id": "/psp/{instrument}/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1"
}

onPaymentToS

This event triggers when the user clicks on the “Display terms and conditions” link. The onPaymentToS event is raised with the following event argument object:

onPaymentToS event object

Copy json to clipboard

1
2
3
4
5
6

{
    "actionType": "OnPaymentToS",
    "openUrl": "https://example.com/terms-of-service",
    "origin": "Merchant",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1"
}

onPaymentTransactionFailed

This event triggers when a payment attempt fails, further attempts can be made for the payment.

An error message will appear in the payment UI, and the payer will be able to try again or choose another payment method. The onPaymentTransactionFailed event is raised with the following event argument object:

onPaymentTransactionFailed event object

Copy json to clipboard

1
2
3
4
5
6

{
    "bodyType": "OnPaymentTransactionFailed",
    "id": "/psp/{instrument}/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "paymentOrderId": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "details": "[HttpCode ProblemTitle]"
}

Updating Payment Menu

When the contents of the shopping cart changes or anything else that affects the amount occurs, the paymentorder must be updated and the Payment Menu must be refreshed.