Actionable

Last updated: September 2, 2026

A type alias for a component, which is:

Describable – It represents the component's name.
Renderable – The component is ready to be rendered.
Submittable – The component is ready to be submitted.
Tokenizable – The component is ready to be tokenized.


1public typealias Actionable = Describable & Renderable & Tokenizable & Submittable


1protocol Describable: Sendable {
2    /// The name of the component.
3    var name: String { get }
4  }


1protocol Renderable: Sendable {
2    /// A Boolean value indicating whether the component is available.
3    var isAvailable: Bool { get }
4    
5    /**
6     Renders a view representing the component.
7     
8     - Returns: A view representing the component.
9     */
10    @MainActor
11    func render() -> AnyView
12  }


1protocol Submittable: Sendable {
2    /// A Boolean value indicating whether the component validation is passed.
3    var isValid: Bool { get }
4
5    /// A Boolean value indicating whether to show the pay button for the component's current step.
6    var isPayButtonRequired: Bool { get }
7    
8    /// Call to start the current payment process
9    func submit()
10  }


1protocol Tokenizable: Sendable {
2  /// The value the asynchronous `tokenize()` returns.
3  ///
4  /// Payment components use `Void` and report their token through the
5  /// `onTokenized` callback. The CVV component uses
6  /// `Result<CvvTokenResponse, CheckoutComponents.Error>?` and returns the
7  /// token directly.
8  associatedtype TokenizedType
9
10  /// A Boolean value indicating whether the component validation is passed.
11  var isValid: Bool { get }
12
13  /// Tokenizes the component's input and returns the result.
14  @discardableResult
15  func tokenize() async -> TokenizedType
16
17  /// Tokenizes the component's input. The result is delivered through the
18  /// `onTokenized` callback rather than returned.
19  func tokenize()
20}

Components report their token in one of two ways, depending on whether they submit to Checkout.com:

Payment components, such as the card component, deliver their token through the onTokenized callback. Their asynchronous tokenize() returns Void.
The CVV component has no payment session to submit to, so its asynchronous tokenize() returns the token directly, as Result<CvvTokenResponse, CheckoutComponents.Error>?.

Renders the component in a SwiftUI view.


1if component.isAvailable {
2  component.render()
3}

Submits a Submittable component, if you require your own pay button.

Information

You cannot call this method for digital wallet payment methods such as Apple Pay or Google Pay. If you do, it triggers an onError callback.


1component.submit()

Tokenizes the selected component, if supported.

For payment components, use the onTokenized() callback to retrieve the generated token and process the token details as required.


1component.tokenize()

For the sessionless CVV component, call the asynchronous overload instead. It returns the token directly, rather than through a callback:


1switch await cvv.tokenize() {
2case .success(let response):
3  print(response.token)
4case .failure(let error):
5  print(error.errorCode)
6case .none:
7  break
8}

Checks if the Submittable component is ready to be submitted. The component is ready if it has:

Captured all of the required details from the customer
Passed validation


1component.isValid

Indicates whether to show the pay button for the component's current step. Defaults to true.

It returns false during intermediate steps of multi-step payment methods. For example, when stc pay requests the customer's phone number.


1component.isPayButtonRequired

Actionable

Describable

Renderable

Submittable

Tokenizable

Methods

render()

submit()

Information

tokenize()

isValid

isPayButtonRequired