Collect a Card

Before You Start

Read the following guides before proceeding:

Overview

WirexCollectForm is one view holding the card inputs. The user types the card inside it; the SDK registers
the card with Wirex and returns a token. Your code receives the token, the brand, the BIN and the last four
digits — never the PAN or the CVV.

Collect needs no action token: it uses accessToken() and the identity from your WirexCredentialProvider.

Choose a Profile

Step 1: Add the Form

class CollectScreen(private val activity: Activity, credentials: WirexCredentialProvider) {
    private val scope = CoroutineScope(Dispatchers.Main)
    private val collect: WirexCollect = WirexCollect.create(credentials = credentials, testMode = true, chainId = "<chain id>")
        ?: error("this build has no endpoints for that environment")
    private lateinit var form: WirexCollectForm

    fun mount(holder: FrameLayout) {
        form = collect.form(context = activity, profile = WirexCollectProfile.TOPUP)
        form.onChange = { state -> updateSubmit(state.isComplete) }
        holder.addView(form, MATCH_PARENT, WRAP_CONTENT)
    }
}

Use WRAP_CONTENT or form.naturalHeightPx(widthPx) for the height. To lay fields out yourself,
form.row(field) returns a single sealed row. form.errorLine sets where validation messages render:
HIDDEN, RESERVED or ANIMATED.

Step 2: Gate Your Submit Button

onChange delivers WirexCollectState:

The sealed fields replace only the card inputs. The billing address and card label come from your own views.
Enable submit only when isComplete is true and your billing address is complete.

Step 3: Tokenize

Top-Up Card

fun tokenize() {
    scope.launch {
        try {
            val token = form.tokenizeTopUp(WirexTopUpTokenizeParams(
                billingDetails = WirexBillingDetails(line1 = "1 High Street", zipCode = "N1 9GU", city = "London", country = "GB"),
                label = "Personal Visa",
            ))
            backend.topUp(externalCardId = token.cardId)
        } catch (error: WirexError) {
            showError(error.code, error.retryable, error.reason)
        }
    }
}

Result (WirexTopUpCardToken):

bin and last4 are out of PCI scope and safe to display.

Payout Card

val token = form.tokenizeOctDestination(WirexOctTokenizeParams(
    cardLabel = "Alex Visa", isSaved = true, isThirdParty = false,
))

The result carries externalCardId — the card token for push to card.

Call form.clear() when the screen goes away.

Step 4: Hand the Token to Your Backend

The SDK makes no money-moving call. Your backend continues the REST flow:

Errors

tokenizeTopUp and tokenizeOctDestination throw WirexError(code, retryable, reason).

Full error handling: Errors, Logging and Troubleshooting.