onInstallmentSelected

onInstallmentSelected is invoked when the buyer picks an installment option in the card form — including the automatic selection of the first option when the list loads. It is informational: the selection travels with the payment either way, so overriding it is optional. Use it to reflect the chosen financing in your own UI (for example, updating an order summary). Available on Web, iOS and Android. On Web, set it inside the card field of the transaction config. The SDK calls it from every card form it renders.

What you receive

Field	Type	Description
`installment`	Int	Number of installments picked.
`label`	String	The option label exactly as rendered to the buyer.
`amount.currency`	String	Currency code of the amounts.
`amount.value`	String	Per-installment amount.
`amount.totalValue` (`amount.total_value` on Web)	String	Total amount across all installments.
`additionalData`	Map?	On iOS (`[String: Any]?`), the plan’s raw `additional_data` object as the backend sent it, `nil` when the backend sent none or it is empty. Reserved on Android and Web; currently `null` (`undefined` on Web).
`isMerchantInstallment`	Boolean?	Reserved on iOS and Android; currently `null`. On Web, `true` when the plans came from your `card.onGetInstallments` hook and `false` for Yuno plans.

amount is null (undefined on Web) when the backend did not provide amounts for the option.

The `null` delivery

The controller receives null (nil on iOS) when a previously reported selection stops being valid — the available installments changed, typically because the buyer edited the card number and the new card has no installment plans. Treat it as “no installment is selected anymore”. It fires at most once per invalidation; a new selection re-arms it.

Signature

Web
iOS
Android

const transaction = sdkPayments.transaction({
  checkoutSession,
  countryCode: 'CO',
  elementSelector: '#payment-form',
  onStatus: (result) => console.log(result.status),
  card: {
    onInstallmentSelected: (installment) => {
      if (installment) orderSummary.showFinancing(installment.label)
      else orderSummary.clearFinancing()
    },
  },
})

func onInstallmentSelected(_ installment: InstallmentSelected?) {
    if let installment {
        orderSummary.showFinancing(installment.label)
    } else {
        orderSummary.clearFinancing()
    }
}

override fun onInstallmentSelected(installment: InstallmentSelected?) {
    installment?.let {
        orderSummary.showFinancing(it.label)
    } ?: orderSummary.clearFinancing()
}

Listen to events. The other informational controllers.
onStatus. The final outcome of the transaction.
Controllers overview. How controllers are wired per platform.

Start here

Guides

Listen and take over

API reference

Upgrade from older SDKs

What you receive

The `null` delivery

Signature

​What you receive

​The null delivery

​Signature

​Related

What you receive

The `null` delivery

Signature

Related