Skip to main content

​
Overview

Set the PrimerHeadlessUniversalCheckoutListener in order to receive different callbacks from Primer SDK. Callbacks can be used for managing the customer journey and trigger actions after specific events throughout the payment journey. See below for a breakdown of all callbacks supported within the Primer SDK.

​
onAvailablePaymentMethodsLoaded

This method will return the payment methods that should be displayed based on the current client session data.
KOTLIN
fun onAvailablePaymentMethodsLoaded(
  paymentMethods: List<PrimerHeadlessUniversalCheckoutPaymentMethod>
)

​
Parameters

​
onCheckoutCompleted

This method will be called when the payment has been completed, returning the payment’ data.
This method won’t be called when you are using PrimerPaymentHandling.MANUAL flow, or the PrimerSessionIntent.VAULT session intent.
KOTLIN
fun onCheckoutCompleted(checkoutData: PrimerCheckoutData)

​
Parameters

​
onBeforePaymentCreated

This method will be called just before the payment gets created, and lets you decide whether you want to proceed with the payment creation.
This method will be called only when using the PrimerPaymentHandling.AUTO flow. Please note, that if you override this method, you must call one of the decisionHandler’s methods.
KOTLIN
fun onBeforePaymentCreated(
  paymentMethodData: PrimerPaymentMethodData,
  decisionHandler: PrimerPaymentCreationDecisionHandler
)

​
Parameters

​
Example

KOTLIN
class CheckoutActivity : AppCompatActivity() {
  // 👇 Add this
  private val listener = object : PrimerCheckoutListener {
    // 👇 Add this
    override fun onBeforePaymentCreated(
      paymentMethodData: PrimerPaymentMethodData,
      decisionHandler: PrimerPaymentCreationDecisionHandler
    ) {
      decisionHandler.continuePaymentCreation()
    }
  }
}

​
onCheckoutAdditionalInfoReceived

This callback is triggered when the payment is not authorized as it’s an asynchronous alternative payment method, such as a voucher payment method.
KOTLIN
fun onCheckoutAdditionalInfoReceived(additionalInfo: PrimerCheckoutAdditionalInfo)

​
onTokenizeSuccess

This method will be called with the when the payment method has been is tokenized, returning the payment method’s tokenization data. Use the token to create a payment on your backend. Make sure that you call the decisionHandler once your operation has been completed.
This method will be called when you are using PrimerPaymentHandling.MANUAL flow, or the PrimerSessionIntent.VAULT session intent.
KOTLIN
fun onTokenizeSuccess(
  paymentMethodTokenData: PrimerPaymentMethodTokenData,
  decisionHandler: PrimerResumeDecisionHandler
)

​
Parameters

​
Example

KOTLIN
class CheckoutActivity : AppCompatActivity() {
  // 👇 Add this
  private val listener = object : PrimerCheckoutListener {
    // 👇 Add this
    override fun onTokenizeSuccess(
      paymentMethodTokenData: PrimerPaymentMethodTokenData,
      decisionHandler: PrimerResumeDecisionHandler
    ) {
      // Create your payment
      val paymentResponse =  //...
      if (paymentResponse.isSuccessful()) {
        // 👇 Call the decisionHandler to show the success screen
        decisionHandler.handleSuccess()
      } else if (paymentResponse.isPending()) {
        // 👇 Call the decisionHandler with the new client token to continue the flow
        decisionHandler.continueWithNewClientToken(paymentResponse.requiredAction.clientToken)
      } else {
        // 👇 Call the decisionHandler to show the error screen with your custom error message
        decisionHandler.handleFailure("Your error message.")
      }
    }
  }
}

​
onCheckoutResume

This method will be called providing a resumeToken so you can resume the payment.
This method will be called when you are using PrimerPaymentHandling.MANUAL flow and when the payment is in a PENDING state.
KOTLIN
fun onResumeSuccess(resumeToken: String, decisionHandler: PrimerResumeDecisionHandler)

​
Parameters

​
Example

KOTLIN
class CheckoutActivity : AppCompatActivity() {
  // 👇 Add this
  private val listener = object : PrimerCheckoutListener {
    // 👇 Add this
    override fun onResumeSuccess(
      resumeToken: String,
      decisionHandler: PrimerResumeDecisionHandler
    ) {
      // Resume your payment
      val paymentResponse =  //...
      if (paymentResponse.isSuccessful()) {
        // 👇 Call the decisionHandler to show the success screen
        decisionHandler.handleSuccess()
      } else if (paymentResponse.isPending()) {
        // 👇 Call the decisionHandler with the new client token to continue the flow
        decisionHandler.continueWithNewClientToken(paymentResponse.requiredAction.clientToken)
      } else {
        // 👇 Call the decisionHandler to show the error screen with your custom error message
        decisionHandler.handleFailure("Your error message.")
      }
    }
  }
}

​
onResumePending

This callback is trigger when the payment is not authorized as it’s an asynchronous alternative payment method, such as a voucher payment method.
This method will be called only when using the PrimerPaymentHandling.MANUAL flow.
KOTLIN
fun onResumePending(additionalInfo: PrimerCheckoutAdditionalInfo)

​
Parameters

​
onBeforeClientSessionUpdated

This method will be called to notify you that the client session will be updated, e.g. a surcharge needs to be applied when a payment method has been chosen.
KOTLIN
fun onBeforeClientSessionUpdated()

​
onClientSessionUpdated

This method will be called to notify you that the client session has been updated, e.g. surcharge has been applied when a payment method has been chosen.
KOTLIN
fun onClientSessionUpdated(clientSession: PrimerClientSession)

​
Parameters

​
onFailed

This method will be called when an error occurs. It may return PrimerCheckoutData if the error occurs after the payment creation.
Please note, that if you override this method, you must call the errorHandler to finalize the flow.
KOTLIN
fun onFailed(error: PrimerError, checkoutData: PrimerCheckoutData?

​
Parameters

​
Example

KOTLIN
class CheckoutActivity : AppCompatActivity() {
    // 👇 Add this
    private val listener = object : PrimerCheckoutListener {
        // 👇 Add this
        override fun onFailed(
            error: PrimerError,
            checkoutData: PrimerCheckoutData?,
            errorHandler: PrimerErrorDecisionHandler?
        ) {
            errorHandler?.showErrorMessage(null)
        }
    }
}