Card Connect

​

What this mode does

​

Parameters

​

Create a token

• Existing entity: provide entity_id + mode + card_connect
• Create new entity: provide entity + mode + card_connect
• Resume session: provide session_id only (omit mode and card_connect)

​

Existing Entity

{
  "entity_id": "ent_...",
  "mode": "card_connect",
  "card_connect": {
    "selection_type": "single",
    "account_filters": {
      "exclude": {
        "mch_ids": ["mch_123"],
        "unverified_account_numbers": true
      }
    }
  }
}

​

Create New Entity

{
  "entity": {
    "type": "individual",
    "individual": {
      "first_name": "Kevin",
      "last_name": "Doyle",
      "phone": "+15125551234"
    }
  },
  "mode": "card_connect",
  "card_connect": {
    "selection_type": "multiple"
  }
}

​

Response

{
  "token": "otkn_...",
  "valid_until": "2025-06-10T22:50:53.024Z",
  "session_id": "osess_..."
}

​

Testing in Development

• Verification code: When the modal prompts you to enter a six-digit verification code, you can use any six-digit code. For example: 123456. This applies to any test case (e.g. identity verification, connect, etc.).
• Card verification: Select the Chase card ending in 1580 and use 878 as the CVV.

​

Launch Opal

import { OpalProvider, useOpal } from "@methodfi/opal-react";

function Screen() {
  const { open } = useOpal({ env: "dev", onEvent: (e) => {} });
  const start = async () => {
    const { token } = await getTokenFromBackend();
    open({ token });
  };
  return <button onClick={start}>Connect Card</button>;
}

import { OpalProvider, useOpal } from "@methodfi/opal-react-native";

function Screen() {
  const { open } = useOpal({ env: "dev", onEvent: (e) => {} });
  const start = async () => {
    const { token } = await getTokenFromBackend();
    open({ token });
  };
  return <Button title="Connect Card" onPress={start} />;
}