Connect SDK

Appearance

@swapped/connect-sdk / wallet-verification / PrepareWalletVerificationRequest

Type Alias: PrepareWalletVerificationRequest ​

PrepareWalletVerificationRequest = object

Defined in: src/types/wallet-verification.types.ts:494

Input for WalletVerificationWallets.prepareVerify. address is required. Always creates a pending record, then starts WalletConnect pairing or a browse deeplink so a QR can be shown.

Example ​

ts
const prepared = await client.wallets.prepareVerify({
  network: 'evm',
  customerId: 'user-1234',
  provider: IntegrationProvider.MetaMask,
  address: '0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B',
  onUri: ({ uri, deeplinkUrl }) => showQr(uri, deeplinkUrl),
  onVerified: finish,
  onError: showError,
})

Properties ​

address ​

address: string

Defined in: src/types/wallet-verification.types.ts:500

Address to verify. Required so create can run before the QR is shown.

Example ​

ts
`'0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B'`

chainId? ​

optional chainId?: ChainId

Defined in: src/types/wallet-verification.types.ts:546

EVM only: chain to request at connect time.

customerEmail? ​

optional customerEmail?: string

Defined in: src/types/wallet-verification.types.ts:531

Optional end-user email. Forwarded to the API on create.

Example ​

ts
`'[email protected]'`

customerId ​

customerId: string

Defined in: src/types/wallet-verification.types.ts:513

Merchant identifier for the end user. Combined with address this is the reuse key - a verified pair returns immediately.

Example ​

ts
`'user-1234'`

force? ​

optional force?: boolean

Defined in: src/types/wallet-verification.types.ts:555

WalletConnect only. Cancel any in-flight pairing before starting a new one. Default true on the WalletConnect prepare path.

forcePopup? ​

optional forcePopup?: boolean

Defined in: src/types/wallet-verification.types.ts:559

Always run an injected complete in the Swapped popup.

network ​

network: WalletVerificationNetwork

Defined in: src/types/wallet-verification.types.ts:506

Chain family to verify. Signature today: evm and solana.

Example ​

ts
`'evm'`

onDeeplinkUrl? ​

optional onDeeplinkUrl?: (payload) => void

Defined in: src/types/wallet-verification.types.ts:568

Browse URL that opens verification inside a wallet in-app browser.

Parameters ​

payload ​
provider ​

IntegrationProvider

url ​

string

Returns ​

void

onError? ​

optional onError?: (error) => void

Defined in: src/types/wallet-verification.types.ts:579

Terminal failure. Same rejection as PreparedWalletVerification.wait.

Parameters ​

error ​

Error

Returns ​

void

onUri? ​

optional onUri?: ConnectWalletRequest["onUri"]

Defined in: src/types/wallet-verification.types.ts:550

WalletConnect pairing callback { uri, deeplinkUrl, provider }.

onVerified? ​

optional onVerified?: (verification) => void

Defined in: src/types/wallet-verification.types.ts:575

Terminal success. Same value as PreparedWalletVerification.wait.

Parameters ​

verification ​

WalletVerification

Returns ​

void

orderId? ​

optional orderId?: string

Defined in: src/types/wallet-verification.types.ts:525

Merchant order reference (metadata only).

Example ​

ts
`'order-9876'`

popupIfUnavailable? ​

optional popupIfUnavailable?: boolean

Defined in: src/types/wallet-verification.types.ts:564

If the iframe cannot see this extension, open a popup instead of failing.

provider ​

provider: IntegrationProvider

Defined in: src/types/wallet-verification.types.ts:519

Wallet the user picked from WalletVerificationWallets.getAvailable.

Example ​

ts
`IntegrationProvider.MetaMask`

transport? ​

optional transport?: WalletTransport

Defined in: src/types/wallet-verification.types.ts:542

Override the QR path. Default: browse-deeplink wallet → browse URL, else WalletConnect when supported. Injected is not the prepare default.

webhookUrl? ​

optional webhookUrl?: string

Defined in: src/types/wallet-verification.types.ts:537

Optional override of the partner default webhook (server-to-server).

Example ​

ts
`'https://merchant.example.com/webhooks/wallet-verification'`