PaymentMethodComponent

Last updated: October 6, 2025


1/*
2 * Payment component interface
3 */
4public interface PaymentMethodComponent {
5  /*
6   * The name of the payment method
7   */
8  public val name: PaymentMethodName
9
10  /*
11   * Check if the payment method is available
12   */
13  public suspend fun isAvailable(): Boolean
14
15  /*
16   * Render the payment method in Composable UI
17   */
18  @Composable
19  public fun Render()
20
21  /**
22    * Allow to tokenize only for the payment method
23    */
24  public suspend fun tokenize()
25
26  /**
27   * Render the payment method in imperative XML/Dynamic views layouts
28   *
29   * @param container - Provide a view container to add the payment method
30   */
31  public fun provideView(container: View): View
32  /**
33    * Allow to submit the payment for the payment method.
34    * The payment submission only works for card payments. All other payment methods return `MethodNotSupportedError`.
35    */
36  public suspend fun submit()
37
38  /**
39    * Checks whether the payment method validation is successful.
40    * The payment validation only works for card payments. All other payment methods return `false`.
41    */
42  public suspend fun isValid(): Boolean  
43}

Renders Flow component in a Compose view.


1flowComponent.Render()

Renders the component in a View container.


1flowComponent.provideView(container)

Tokenizes the selected component, if supported.

Use the onTokenized() callback to retrieve the generated token and process the token details as required.


1flowComponent.tokenize()
2
3cardComponent.tokenize()

Submits the payment for the payment method when using the custom pay button. The payment submission only works for card payments. All other payment methods return MethodNotSupportedError.


1flowComponent.submit()
2
3cardComponent.submit()

Checks whether the payment method validation is successful.

The payment validation only works for card payments. All other payment methods return false.


1flowComponent.isValid()
2
3cardComponent.isValid()

Applies the changes specified in UpdateDetails to the Flow for Mobile UI. For example, to modify the payment amount displayed to the customer, provide a new amount value in UpdateDetails, in minor currency units.

Information

This only modifies the UI. To update the payment session with your changes, use the handleSubmit callback.


1flowComponent.update(updateDetails)
2
3cardComponent.update(updateDetails)

PaymentMethodComponent

Methods

Render()

provideView()

tokenize()

submit()

isValid

update(updateDetails: UpdateDetails)

Information