Payment Menu Events

Payment Menu Events

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

onPaymentPending

This events triggers when a payment enters a paying state ( Sale, Authorize, Canceletc). The onPaymentPending event will be followed by either onPaymentPaid, onPaymentFailed or onPaymentTransactionFailed based on the result of the payment. Read more about these events below.

onPaymentPending event object

1
2
3

{
    "id": "/psp/paymentorders/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1"
}

onPaymentPaid

This event triggers when a payment has completed successfully. The onPaymentPaid event is raised with the following event argument object:

onPaymentPaid event object

1
2
3
4

{
    "id": "/psp/paymentorders/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "redirectUrl": "https://example.com/complete"
}

onPaymentAborted

This event triggers when the user cancels the payment. The onPaymentAborted event is raised with the following event argument object:

onPaymentAborted event object

1
2
3
4

{
    "id": "/psp/paymentorderspayments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "redirectUrl": "https://example.com/cancelled"
}

onPaymentFailed

This event triggers 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

1
2
3
4

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

onTermsOfServiceRequested

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

onTermsOfServiceRequested event object

1
2
3
4

{
    "origin": "owner",
    "openUrl": "https://example.com/terms-of-service"
}

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

1
2
3
4
5

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

onBillingDetailsAvailable

This event triggers when a consumer has been identified. The onBillingDetailsAvailable event will be raised with the following event argument object:

onBillingDetailsAvailable event object

1
2
3
4

{
    "actionType": "OnBillingDetailsAvailable",
    "url": "/psp/consumers//billing-details",
}

onShippingDetailsAvailable

This event triggers when a consumer has been identified or their shipping address has been updated. The onShippingDetailsAvailable event will be raised with the following event argument object:

onShippingDetailsAvailable event object

1
2
3
4

{
    "actionType": "OnShippingDetailsAvailable",
    "url": "/psp/consumers//shipping-details",
}

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

1
2
3

{
    "details": "source: "PaymentMenuClient", bodyHeight: "[clientHeight of iframe content]""
}

onEventNotification

This event triggers whenever any other public event is called. It does not prevent their handling. The onEventNotification event is raised with the following event argument object:

onEventNotification event object

1
2
3

{
    "details": "Name of the event called"
}

onInstrumentSelected

This event triggers when a user actively changes payment instrument in the Payment Menu. The onInstrumentSelected event is raised with the following event argument object:

onInstrumentSelected event object

1
2
3
4
5

{
    "name": "menu identifier",
    "id": "/psp/paymentorders/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "instrument": "creditcard | vipps | swish | invoice",
}

onPaymentCreated

This event triggers when a user has selected a payment instrument and actively attempts to perform a payment. The onPaymentCreated event is raised with the following event argument object:

onPaymentCreated event object

1
2
3
4

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

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 instrument. The onPaymentTransactionFailed event is raised with the following event argument object:

onPaymentTransactionFailed event object

1
2
3
4

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

onOutOfViewRedirect

This event triggers when a user is redirected to a separate web page, for example 3-D Secure or Bank ID signing. The onOutOfViewRedirect event is raised with the following event argument object:

onOutOfViewRedirect event object

1
2
3

{
    "redirectUrl": "https://external.example.com/"
}

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.