The WalletConnect Pay SDK allows wallet users to pay merchants using their crypto assets. The SDK handles payment option discovery, permit signing coordination, and payment confirmation while leveraging your wallet’s existing signing infrastructure.
Requirements
- React Native 0.70+
@walletconnect/react-native-compat installed and linked
Installation
Install the WalletConnect Pay SDK using npm or yarn:
npm install @walletconnect/pay
yarn add @walletconnect/pay
React Native Setup
This SDK requires the WalletConnect React Native native module. Make sure you have @walletconnect/react-native-compat installed and linked in your React Native project:
npm install @walletconnect/react-native-compat
Architecture
The SDK uses a provider abstraction that allows different implementations:
- NativeProvider: Uses React Native uniffi module (current)
- WasmProvider: Uses WebAssembly module (coming soon for web browsers)
The SDK auto-detects the best available provider for your environment.
Configuration
Initialize the WalletConnect Pay client with your credentials:
import { WalletConnectPay } from "@walletconnect/pay";
const client = new WalletConnectPay({
appId: "your-app-id",
// OR use apiKey instead:
// apiKey: "your-api-key",
});
Configuration Parameters
| Parameter | Type | Required | Description |
|---|
appId | string | No* | App ID for authentication |
apiKey | string | No* | API key for authentication |
clientId | string | No | Client ID for tracking |
baseUrl | string | No | Custom API base URL |
logger | Logger | No | Custom logger instance or level |
Either appId or apiKey must be provided for authentication.
Supported Networks
WalletConnect Pay currently supports the following networks with USDC:
| Network | Chain ID | CAIP-10 Format |
|---|
| Ethereum | 1 | eip155:1:{address} |
| Base | 8453 | eip155:8453:{address} |
| Optimism | 10 | eip155:10:{address} |
| Polygon | 137 | eip155:137:{address} |
| Arbitrum | 42161 | eip155:42161:{address} |
Support for all EVM chains, Solana, and additional native and non-native assets is coming soon. Include accounts for all supported networks to maximize payment options for your users.
Payment Flow
The payment flow consists of four main steps:
Get Options -> Get Actions -> Sign Actions -> Confirm Payment
Get Payment Options
When a user scans a payment QR code or opens a payment link, fetch available payment options:const options = await client.getPaymentOptions({
paymentLink: "https://pay.walletconnect.com/pay_123",
accounts: [
`eip155:1:${walletAddress}`, // Ethereum Mainnet
`eip155:8453:${walletAddress}`, // Base
],
includePaymentInfo: true,
});
console.log("Payment ID:", options.paymentId);
console.log("Options:", options.options);
// Display merchant info
if (options.info) {
console.log("Merchant:", options.info.merchant.name);
console.log("Amount:", options.info.amount.display.assetSymbol, options.info.amount.value);
}
// Check if user data collection is required
if (options.collectData) {
console.log("Required fields:", options.collectData.fields);
}
Get Required Actions
After the user selects a payment option, get the wallet RPC actions required to complete the payment:const actions = await client.getRequiredPaymentActions({
paymentId: options.paymentId,
optionId: options.options[0].id,
});
// Each action contains wallet RPC data to sign
for (const action of actions) {
console.log("Chain:", action.walletRpc.chainId);
console.log("Method:", action.walletRpc.method);
console.log("Params:", action.walletRpc.params);
}
Sign Actions
Sign each action with your wallet’s signing implementation:// Sign each action with your wallet (implementation depends on your wallet SDK)
const signatures = await Promise.all(
actions.map((action) =>
wallet.signTypedData(
action.walletRpc.chainId,
JSON.parse(action.walletRpc.params)
)
)
);
Signatures must be in the same order as the actions array.
Collect User Data (If Required)
Some payments may require additional user data. Check for collectData in the payment options response:WebView-Based Data Collection
When a payment requires user information (e.g., for Travel Rule compliance), the SDK returns a collectDataAction with a url field pointing to a WalletConnect-hosted form page.Instead of building native forms, wallets display this URL in a WebView. The hosted form handles rendering, validation, and Terms & Conditions acceptance. When the user completes the form, the WebView communicates back to the wallet via JavaScript bridge messages.How It Works
- Check if
collectDataAction.url is present in the payment options response
- Open the URL in a WebView within your wallet
- Optionally append a
prefill=<base64-json> query parameter with known user data (e.g., name, date of birth, address). Use proper URL building to handle existing query parameters.
- Listen for JS bridge messages:
IC_COMPLETE (success) or IC_ERROR (failure)
- On
IC_COMPLETE, proceed to confirmPayment() without passing collectedData — the WebView submits data directly to the backend
The collectDataAction also includes a schema field — a JSON schema string describing the required fields. The required list in this schema tells you which fields the form expects. Wallets can use these field names as keys when building the prefill JSON object. For example, if the schema’s required array contains ["fullName", "dateOfBirth", "pobAddress"], you can prefill with {"fullName": "...", "dateOfBirth": "...", "pobAddress": "..."}.
When using the WebView approach, do not pass collectedData to confirmPayment(). The WebView handles data submission directly.
if (options.collectData?.url) {
// Use the "required" list from options.collectData.schema to determine which fields to prefill
const prefillData = {
fullName: "John Doe",
dateOfBirth: "1990-01-15",
pobAddress: "123 Main St, New York, NY 10001",
};
const prefillBase64 = btoa(JSON.stringify(prefillData));
const separator = options.collectData.url.includes("?") ? "&" : "?";
const webViewUrl = `${options.collectData.url}${separator}prefill=${prefillBase64}`;
// Show WebView — see WebView Implementation section below
showDataCollectionWebView(webViewUrl);
}
WebView Message Types
The WebView communicates with your wallet through JavaScript bridge messages. The message payload is a JSON string with the following structure:| Message Type | Payload | Description |
|---|
IC_COMPLETE | { "type": "IC_COMPLETE", "success": true } | User completed the form successfully. Proceed to payment confirmation. |
IC_ERROR | { "type": "IC_ERROR", "error": "..." } | An error occurred. Display the error message and allow the user to retry. |
| Platform | Bridge Name | Handler |
|---|
| Kotlin (Android) | AndroidWallet | @JavascriptInterface onDataCollectionComplete(json: String) |
| Swift (iOS) | payDataCollectionComplete | WKScriptMessageHandler.didReceive(message:) |
| Flutter | ReactNativeWebView (injected via JS bridge) | JavaScriptChannel.onMessageReceived |
| React Native | ReactNativeWebView (native) | WebView.onMessage prop |
Confirm Payment
Submit the signatures and collected data to complete the payment:const result = await client.confirmPayment({
paymentId: options.paymentId,
optionId: options.options[0].id,
signatures,
collectedData, // Include if collectData was present
});
if (result.status === "succeeded") {
console.log("Payment successful!");
} else if (result.status === "processing") {
console.log("Payment is processing...");
} else if (result.status === "failed") {
console.log("Payment failed");
}
WebView Implementation
When collectData.url is present, display the URL in a WebView using react-native-webview. Install the dependency:
import React, { useCallback } from "react";
import { WebView, WebViewMessageEvent } from "react-native-webview";
import { Linking, View, ActivityIndicator } from "react-native";
interface PayDataCollectionWebViewProps {
url: string;
onComplete: () => void;
onError: (error: string) => void;
}
function PayDataCollectionWebView({
url,
onComplete,
onError,
}: PayDataCollectionWebViewProps) {
const handleMessage = useCallback(
(event: WebViewMessageEvent) => {
try {
const data = JSON.parse(event.nativeEvent.data);
switch (data.type) {
case "IC_COMPLETE":
onComplete();
break;
case "IC_ERROR":
onError(data.error || "Unknown error");
break;
}
} catch {
// Ignore non-JSON messages
}
},
[onComplete, onError]
);
const handleNavigationRequest = useCallback(
(request: { url: string }) => {
// Open external links (T&C, Privacy Policy) in system browser
if (!request.url.includes("pay.walletconnect.com")) {
Linking.openURL(request.url);
return false;
}
return true;
},
[]
);
return (
<WebView
source={{ uri: url }}
onMessage={handleMessage}
onShouldStartLoadWithRequest={handleNavigationRequest}
javaScriptEnabled
domStorageEnabled
startInLoadingState
renderLoading={() => (
<View style={{ flex: 1, justifyContent: "center", alignItems: "center" }}>
<ActivityIndicator size="large" />
</View>
)}
/>
);
}
function buildPrefillUrl(
baseUrl: string,
prefillData: Record<string, string>
): string {
if (Object.keys(prefillData).length === 0) return baseUrl;
const base64 = btoa(JSON.stringify(prefillData));
const separator = baseUrl.includes("?") ? "&" : "?";
return `${baseUrl}${separator}prefill=${base64}`;
}
Complete Example
Here’s a complete implementation example:
import { WalletConnectPay, CollectDataFieldResult } from "@walletconnect/pay";
class PaymentManager {
private client: WalletConnectPay;
constructor() {
this.client = new WalletConnectPay({
appId: "your-app-id",
});
}
async processPayment(paymentLink: string, walletAddress: string) {
try {
// Step 1: Get payment options
const options = await this.client.getPaymentOptions({
paymentLink,
accounts: [
`eip155:1:${walletAddress}`,
`eip155:137:${walletAddress}`,
`eip155:8453:${walletAddress}`,
],
includePaymentInfo: true,
});
if (options.options.length === 0) {
throw new Error("No payment options available");
}
// Step 2: Let user select an option (simplified - use first option)
const selectedOption = options.options[0];
// Step 3: Get required actions
const actions = await this.client.getRequiredPaymentActions({
paymentId: options.paymentId,
optionId: selectedOption.id,
});
// Step 4: Sign all actions
const signatures = await Promise.all(
actions.map((action) =>
this.signAction(action, walletAddress)
)
);
// Step 5: Collect data via WebView if required
if (options.collectData?.url) {
// Show WebView and wait for IC_COMPLETE
await this.showDataCollectionWebView(options.collectData.url);
}
// Step 6: Confirm payment
const result = await this.client.confirmPayment({
paymentId: options.paymentId,
optionId: selectedOption.id,
signatures,
});
return result;
} catch (error) {
console.error("Payment failed:", error);
throw error;
}
}
private async signAction(action: Action, walletAddress: string): Promise<string> {
const { chainId, method, params } = action.walletRpc;
// Use your wallet's signing implementation
return await wallet.signTypedData(chainId, JSON.parse(params));
}
}
Provider Utilities
The SDK provides utilities for checking provider availability:
import {
isProviderAvailable,
detectProviderType,
isNativeProviderAvailable,
setNativeModule,
} from "@walletconnect/pay";
// Check if any provider is available
if (isProviderAvailable()) {
// SDK can be used
}
// Detect which provider type is available
const providerType = detectProviderType(); // 'native' | 'wasm' | null
// Check specifically for native provider
if (isNativeProviderAvailable()) {
// React Native native module is available
}
// Manually inject native module (if auto-discovery fails)
import { NativeModules } from "react-native";
setNativeModule(NativeModules.RNWalletConnectPay);
Error Handling
The SDK throws typed errors for different failure scenarios:
import {
PayError,
PaymentOptionsError,
PaymentActionsError,
ConfirmPaymentError,
NativeModuleNotFoundError
} from "@walletconnect/pay";
try {
const options = await client.getPaymentOptions({
paymentLink: link,
accounts,
});
} catch (error) {
if (error instanceof PaymentOptionsError) {
console.error("Failed to get options:", error.originalMessage);
} else if (error instanceof PayError) {
console.error("Pay error:", error.code, error.message);
}
}
Error Types
| Error Class | Description |
|---|
PayError | Base error class for all Pay SDK errors |
PaymentOptionsError | Error when fetching payment options |
PaymentActionsError | Error when fetching required payment actions |
ConfirmPaymentError | Error when confirming payment |
NativeModuleNotFoundError | Error when native module is not available |
Error Codes
The PayError class includes a code property with one of the following values:
type PayErrorCode =
| "JSON_PARSE"
| "JSON_SERIALIZE"
| "PAYMENT_OPTIONS"
| "PAYMENT_REQUEST"
| "CONFIRM_PAYMENT"
| "NATIVE_MODULE_NOT_FOUND"
| "INITIALIZATION_ERROR"
| "UNKNOWN";
API Reference
WalletConnectPay
Main client for payment operations.
Constructor
new WalletConnectPay(options: WalletConnectPayOptions)
Methods
| Method | Description |
|---|
getPaymentOptions(params) | Fetch available payment options |
getRequiredPaymentActions(params) | Get signing actions for a payment option |
confirmPayment(params) | Confirm and execute the payment |
static isAvailable() | Check if a provider is available |
Data Types
PaymentStatus
type PaymentStatus =
| "requires_action"
| "processing"
| "succeeded"
| "failed"
| "expired";
PayProviderType
type PayProviderType = "native" | "wasm";
CollectDataFieldType
type CollectDataFieldType = "text" | "date";
Method Parameters
interface GetPaymentOptionsParams {
/** Payment link or ID */
paymentLink: string;
/** List of CAIP-10 accounts */
accounts: string[];
/** Whether to include payment info in response */
includePaymentInfo?: boolean;
}
interface GetRequiredPaymentActionsParams {
/** Payment ID */
paymentId: string;
/** Option ID */
optionId: string;
}
interface ConfirmPaymentParams {
/** Payment ID */
paymentId: string;
/** Option ID */
optionId: string;
/** Signatures from wallet RPC calls */
signatures: string[];
}
Response Types
interface PaymentOptionsResponse {
/** Payment ID extracted from the payment link */
paymentId: string;
/** Payment information (if includePaymentInfo was true) */
info?: PaymentInfo;
/** Available payment options */
options: PaymentOption[];
/** Data collection requirements (if any) */
collectData?: CollectDataAction;
/** Transaction result details (present when payment already completed) */
resultInfo?: PaymentResultInfo;
}
interface PaymentResultInfo {
/** Transaction ID */
txId: string;
/** Token amount details */
optionAmount: PayAmount;
}
interface ConfirmPaymentResponse {
/** Payment status */
status: PaymentStatus;
/** True if the payment is in a final state */
isFinal: boolean;
/** Time to poll for payment status, in milliseconds */
pollInMs?: number;
}
PaymentOption
interface PaymentOption {
/** ID of the option */
id: string;
/** The option's token and amount */
amount: PayAmount;
/** Estimated time to complete the option, in seconds */
etaS: number;
/** Actions required to complete the option */
actions: Action[];
}
Action
interface Action {
walletRpc: WalletRpcAction;
}
interface WalletRpcAction {
/** Chain ID in CAIP-2 format (e.g., "eip155:8453") */
chainId: string;
/** RPC method name (e.g., "eth_signTypedData_v4") */
method: string;
/** JSON-encoded params array */
params: string;
}
Amount Types
interface PayAmount {
/** Currency unit, prefixed with either "iso4217/" or "caip19/" */
unit: string;
/** Amount value, in the currency unit's minor units */
value: string;
/** Display information for the amount */
display: AmountDisplay;
}
interface AmountDisplay {
/** Ticker/symbol of the asset */
assetSymbol: string;
/** Full name of the asset */
assetName: string;
/** Number of minor decimals of the asset */
decimals: number;
/** URL of the icon of the asset (if token) */
iconUrl?: string;
/** Name of the network of the asset (if token) */
networkName?: string;
}
Payment Info Types
interface PaymentInfo {
/** Payment status */
status: PaymentStatus;
/** Amount to be paid */
amount: PayAmount;
/** Payment expiration timestamp, in seconds since epoch */
expiresAt: number;
/** Merchant information */
merchant: MerchantInfo;
/** Buyer information (present if payment has been submitted) */
buyer?: BuyerInfo;
}
interface MerchantInfo {
/** Merchant name */
name: string;
/** Merchant icon URL */
iconUrl?: string;
}
interface BuyerInfo {
/** Account CAIP-10 */
accountCaip10: string;
/** Account provider name */
accountProviderName: string;
/** Account provider icon URL */
accountProviderIcon?: string;
}
Collect Data Types
interface CollectDataAction {
/** WebView URL for data collection */
url: string;
/** JSON schema describing required fields */
schema?: string;
}
Best Practices
-
Check Provider Availability: Always check if a provider is available before using the SDK
-
Account Format: Always use CAIP-10 format for accounts:
eip155:{chainId}:{address}
-
Multiple Chains: Provide accounts for all supported chains to maximize payment options
-
Signature Order: Maintain the same order of signatures as the actions array
-
Error Handling: Always handle errors gracefully and show appropriate user feedback
-
Loading States: Show loading indicators during API calls and signing operations
-
Expiration: Check
paymentInfo.expiresAt and warn users if time is running low
-
User Data: Only collect data when
collectData is present in the response and you don’t already have the required user data. If you already have the required data, you can submit this without collecting from the user. You must make sure the user accepts WalletConnect Terms and Conditions and Privacy Policy before submitting user information to WalletConnect.
-
WebView Data Collection: When
collectData.url is present, display the URL in a WebView using react-native-webview rather than building native forms. The WebView handles form rendering, validation, and T&C acceptance.