> ## Documentation Index
> Fetch the complete documentation index at: https://walletconnect-pay-docs-wcagent-expires-at-seconds-warning-3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# WalletConnect Pay via WalletKit - React Native
> Integrate WalletConnect Pay through WalletKit for a unified payment experience in your React Native wallet.
This documentation covers integrating WalletConnect Pay through WalletKit for React Native wallets. This approach provides a unified API where Pay is built into WalletKit, simplifying the integration for wallet developers.
## Sample Wallet
For a complete working example, check out our sample wallet implementation:
A reference React Native wallet app demonstrating WalletConnect Pay via WalletKit.
**Using AI for Integration?** If you're using an AI IDE or assistant to help with integration, you can provide it with our comprehensive [AI integration prompt](/payments/wallets/walletkit/ai-prompts/react-native) for better context and guidance.
## Requirements
* Node.js 16+
* WalletKit (`@reown/walletkit`)
## Pre-Requisites
In order to use your WalletConnect Pay, you need to obtain a WCP ID for your project from the [WalletConnect Dashboard](https://dashboard.walletconnect.com).
### How to obtain a WCP ID
1. Navigate to the [WalletConnect Dashboard](https://dashboard.walletconnect.com).
2. Select the project that is associated with your wallet (as in, the projectId that is being used for your wallet's WalletConnect integration).
3. Click on the "Get Started" button to get a WCP ID associated with your project.
4. The Dashboard will now show the WCP ID associated with your project.
5. Click on the three dots on the right of the WCP ID and select "Copy WCP ID". You will be using this for your wallet's WalletConnect Pay integration.
## Installation
Install WalletKit using npm or yarn:
```bash theme={null}
npm install @reown/walletkit @walletconnect/core
```
```bash theme={null}
yarn add @reown/walletkit @walletconnect/core
```
WalletConnect Pay is automatically included as part of WalletKit.
Check the [npm page](https://www.npmjs.com/package/@reown/walletkit) for the latest version.
## Initialization
Initialize WalletKit as usual. Pay functionality is automatically available:
```javascript theme={null}
import { Core } from "@walletconnect/core";
import { WalletKit } from "@reown/walletkit";
const core = new Core({
projectId: process.env.PROJECT_ID,
});
const walletkit = await WalletKit.init({
core, // <- pass the shared `core` instance
metadata: {
name: "Demo app",
description: "Demo Client as Wallet/Peer",
url: "www.walletconnect.com",
icons: [],
},
payConfig: {
appId: "",
// or
apiKey: "",
}
});
```
## Payment Link Detection
Use `isPaymentLink` to determine if a scanned URI is a payment link or a standard WalletConnect pairing URI:
```javascript theme={null}
import { isPaymentLink } from "@reown/walletkit";
// Use when handling a scanned QR code or deep link
if (isPaymentLink(uri)) {
// Handle as payment (see below)
await processPayment(uri);
} else {
// Handle as WalletConnect pairing
await walletkit.pair({ uri });
}
```
## Payment Flow
The payment flow consists of five main steps:
**Detect Payment Link -> Get Options -> Get Actions -> Sign Actions -> Confirm Payment**
```mermaid theme={null}
sequenceDiagram
participant User
participant Wallet
participant WalletKit as WalletKit.Pay
participant Backend as WalletConnect Pay
participant WebView
User->>Wallet: Scan QR / Open payment link
Wallet->>WalletKit: isPaymentLink(uri)
WalletKit-->>Wallet: true
Wallet->>WalletKit: pay.getPaymentOptions(params)
WalletKit->>Backend: Fetch payment options
Backend-->>WalletKit: Payment options + merchant info
WalletKit-->>Wallet: PaymentOptionsResponse
Wallet->>User: Display payment options
User->>Wallet: Select payment option
Wallet->>WalletKit: pay.getRequiredPaymentActions(params)
WalletKit->>Backend: Get signing actions
Backend-->>WalletKit: Required wallet RPC actions
WalletKit-->>Wallet: List of actions to sign
Wallet->>User: Request signature(s)
User->>Wallet: Approve & sign
alt Data collection required
Wallet->>WebView: Load collectDataAction.url in WebView
WebView->>User: Display data collection form
User->>WebView: Fill form & accept T&C
WebView-->>Wallet: IC_COMPLETE message
end
Wallet->>WalletKit: pay.confirmPayment(params)
WalletKit->>Backend: Submit payment
Backend-->>WalletKit: Payment status
WalletKit-->>Wallet: ConfirmPaymentResponse
Wallet->>User: Show result
```
Retrieve available payment options for a payment link:
```javascript theme={null}
const options = await walletkit.pay.getPaymentOptions({
paymentLink: "https://pay.walletconnect.com/...",
accounts: ["eip155:1:0x...", "eip155:8453:0x..."],
includePaymentInfo: true,
});
// options.paymentId - unique payment identifier
// options.options - array of payment options (different tokens/chains)
// options.info - payment details (amount, merchant, expiry)
// 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 data collection is required
if (options.collectData) {
console.log("Required fields:", options.collectData.fields);
}
```
Get the wallet RPC actions needed to complete the payment:
```javascript theme={null}
const actions = await walletkit.pay.getRequiredPaymentActions({
paymentId: options.paymentId,
optionId: options.options[0].id,
});
// actions - array of wallet RPC calls to sign
// Each action contains: { walletRpc: { chainId, method, params } }
for (const action of actions) {
console.log("Chain:", action.walletRpc.chainId);
console.log("Method:", action.walletRpc.method);
console.log("Params:", action.walletRpc.params);
}
```
Sign each required action using your wallet's signing implementation:
```javascript theme={null}
// Sign each action based on its RPC method
const signatures = await Promise.all(
actions.map(async (action) => {
const { chainId, method, params } = action.walletRpc;
const parsedParams = JSON.parse(params);
switch (method) {
case "eth_signTypedData_v4":
return await wallet.signTypedData(chainId, parsedParams);
case "eth_sendTransaction":
return await wallet.sendTransaction(chainId, parsedParams[0]);
case "personal_sign":
return await wallet.personalSign(chainId, parsedParams);
default:
throw new Error(`Unsupported RPC method: ${method}`);
}
})
);
```
Payment options may include multiple actions with different RPC methods. For example, a Permit2 payment where the user lacks sufficient allowance returns two actions: an `eth_sendTransaction` to approve the token allowance, followed by an `eth_signTypedData_v4` to sign the Permit2 transfer. Your wallet must check `action.walletRpc.method` and dispatch to the appropriate handler. For full implementation guidance, see [USDT support](/payments/wallets/token-chain-support/usdt-support).
Signatures must be in the same order as the actions array.
Some payments may require additional user data:
## WebView-Based Data Collection
When a payment requires user information (e.g., for Travel Rule compliance), the SDK returns a `collectData` field on individual payment options. Each option may independently require data collection — some options may require it while others don't.
### Recommended Flow (Per-Option)
The recommended approach is to display all payment options upfront, then handle data collection only when the user selects an option that requires it:
1. Call `getPaymentOptions` and display all available options to the user
2. Show a visual indicator (e.g., "Info required" badge) on options where `option.collectData` is present
3. When the user selects an option, check `selectedOption.collectData`
4. If present, open `selectedOption.collectData.url` in a WebView within your wallet
5. Optionally append a `prefill=` query parameter with known user data (e.g., name, date of birth, address). Use proper URL building to handle existing query parameters.
6. Listen for JS bridge messages: `IC_COMPLETE` (success) or `IC_ERROR` (failure)
7. On `IC_COMPLETE`, proceed to `confirmPayment()` **without** passing `collectedData` — the WebView submits data directly to the backend
### Decision Matrix
| Response `collectData` | `option.collectData` | Behavior |
| ---------------------- | -------------------- | ------------------------------------------------------------------- |
| present | present | Option requires IC — use `option.collectData.url` |
| present | `null` | Option does NOT require IC (others might) — skip IC for this option |
| `null` | `null` | No IC needed for any option |
The `collectData` 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", "dob", "pobAddress"]`, you can prefill with `{"fullName": "...", "dob": "...", "pobAddress": "..."}`.
The top-level `collectData` on the payment options response is still available for backward compatibility. However, the per-option `collectData` is the recommended approach as it provides more granular control over the flow.
When using the WebView approach, do **not** pass `collectedData` to `confirmPayment()`. The WebView handles data submission directly.
```javascript theme={null}
if (options.collectData?.url) {
// Use the "required" list from options.collectData.schema to determine which fields to prefill
const prefillData = {
fullName: "John Doe",
dob: "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 and wait for IC_COMPLETE message
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-Specific Bridge Names
| 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 |
Submit the signatures and collected data to complete the payment:
```javascript theme={null}
const result = await walletkit.pay.confirmPayment({
paymentId: options.paymentId,
optionId: options.options[0].id,
signatures,
collectedData, // Optional, if collectData was present
});
// result.status - "succeeded" | "processing" | "failed" | "expired"
// result.isFinal - whether the payment is complete
// result.pollInMs - if not final, poll again after this delay
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:
```bash theme={null}
npm install react-native-webview@13.16.0
```
```jsx theme={null}
import React, { useCallback } from "react";
import { WebView } from "react-native-webview";
import { Linking, View, ActivityIndicator } from "react-native";
function PayDataCollectionWebView({ url, onComplete, onError }) {
const handleMessage = useCallback(
(event) => {
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) => {
if (!request.url.includes("pay.walletconnect.com")) {
Linking.openURL(request.url);
return false;
}
return true;
}, []);
return (
(
)}
/>
);
}
function buildPrefillUrl(baseUrl, prefillData) {
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:
```javascript theme={null}
import { Core } from "@walletconnect/core";
import { WalletKit, isPaymentLink } from "@reown/walletkit";
class PaymentManager {
constructor() {
this.walletkit = null;
}
async initialize(projectId) {
const core = new Core({ projectId });
this.walletkit = await WalletKit.init({
core,
metadata: {
name: "My Wallet",
description: "A crypto wallet",
url: "https://mywallet.com",
icons: ["https://mywallet.com/icon.png"],
},
});
}
async handleScannedUri(uri) {
if (isPaymentLink(uri)) {
await this.processPayment(uri);
} else {
await this.walletkit.pair({ uri });
}
}
async processPayment(paymentLink) {
const walletAddress = "0xYourAddress";
try {
// Step 1: Get payment options
const options = await this.walletkit.pay.getPaymentOptions({
paymentLink,
accounts: [
`eip155:1:${walletAddress}`,
`eip155:8453:${walletAddress}`,
`eip155:137:${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.walletkit.pay.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) {
await this.showDataCollectionWebView(options.collectData.url);
}
// Step 6: Confirm payment
const result = await this.walletkit.pay.confirmPayment({
paymentId: options.paymentId,
optionId: selectedOption.id,
signatures,
});
return result;
} catch (error) {
console.error("Payment failed:", error);
throw error;
}
}
async signAction(action, walletAddress) {
const { chainId, method, params } = action.walletRpc;
const parsedParams = JSON.parse(params);
switch (method) {
case "eth_signTypedData_v4":
return await wallet.signTypedData(chainId, parsedParams);
case "eth_sendTransaction":
return await wallet.sendTransaction(chainId, parsedParams[0]);
case "personal_sign":
return await wallet.personalSign(chainId, parsedParams);
default:
throw new Error(`Unsupported RPC method: ${method}`);
}
}
}
```
## API Reference
### WalletKit Pay Methods
Pay methods are accessed via `walletkit.pay.*`.
#### Utility Functions
| Function | Description |
| ------------------------------------- | ----------------------------------------------------------------- |
| `isPaymentLink(uri: string): boolean` | Check if URI is a payment link (imported from `@reown/walletkit`) |
#### Instance Methods (walletkit.pay)
| Method | Description |
| ----------------------------------- | ---------------------------------------- |
| `getPaymentOptions(params)` | Fetch available payment options |
| `getRequiredPaymentActions(params)` | Get signing actions for a payment option |
| `confirmPayment(params)` | Confirm and execute the payment |
### Parameters
#### GetPaymentOptionsParams
```typescript theme={null}
interface GetPaymentOptionsParams {
paymentLink: string; // Payment link URL
accounts: string[]; // CAIP-10 accounts
includePaymentInfo?: boolean; // Include payment info in response
}
```
#### GetRequiredPaymentActionsParams
```typescript theme={null}
interface GetRequiredPaymentActionsParams {
paymentId: string; // Payment ID from getPaymentOptions
optionId: string; // Selected option ID
}
```
#### ConfirmPaymentParams
```typescript theme={null}
interface ConfirmPaymentParams {
paymentId: string; // Payment ID
optionId: string; // Selected option ID
signatures: string[]; // Signatures from wallet RPC calls
}
```
### Response Types
#### PaymentOptionsResponse
```typescript theme={null}
interface PaymentOptionsResponse {
paymentId: string; // Unique payment identifier
info?: PaymentInfo; // Payment information
options: PaymentOption[]; // Available payment options
collectData?: CollectDataAction; // Data collection requirements
resultInfo?: PaymentResultInfo; // Transaction result details (present when payment already completed)
}
interface PaymentResultInfo {
txId: string; // Transaction ID
optionAmount: PayAmount; // Token amount details
}
```
#### PaymentOption
```typescript theme={null}
interface PaymentOption {
id: string; // Option identifier
amount: PayAmount; // Amount in this asset
etaS: number; // Estimated time to complete (seconds)
actions: Action[]; // Required signing actions
}
```
#### Action
```typescript theme={null}
interface Action {
walletRpc: WalletRpcAction;
}
interface WalletRpcAction {
chainId: string; // CAIP-2 chain ID (e.g., "eip155:8453")
method: string; // RPC method (e.g., "eth_signTypedData_v4", "eth_sendTransaction")
params: string; // JSON-encoded parameters
}
```
#### ConfirmPaymentResponse
```typescript theme={null}
interface ConfirmPaymentResponse {
status: PaymentStatus; // Payment status
isFinal: boolean; // Whether status is final
pollInMs?: number; // Suggested poll interval
info?: PaymentResultInfo; // Transaction result details (present on success)
}
type PaymentStatus =
| "requires_action"
| "processing"
| "succeeded"
| "failed"
| "expired"
| "cancelled";
```
#### PaymentInfo
```typescript theme={null}
interface PaymentInfo {
status: PaymentStatus; // Current payment status
amount: PayAmount; // Requested payment amount
expiresAt: number; // Expiration timestamp (seconds since epoch)
merchant: MerchantInfo; // Merchant details
buyer?: BuyerInfo; // Buyer info if available
}
interface MerchantInfo {
name: string; // Merchant display name
iconUrl?: string; // Merchant logo URL
}
```
#### PayAmount
```typescript theme={null}
interface PayAmount {
unit: string; // Asset unit
value: string; // Raw value in smallest unit
display: AmountDisplay; // Human-readable display info
}
interface AmountDisplay {
assetSymbol: string; // Token symbol (e.g., "USDC")
assetName: string; // Token name (e.g., "USD Coin")
decimals: number; // Token decimals
iconUrl?: string; // Token icon URL
networkName?: string; // Network name (e.g., "Base")
}
```
#### CollectDataAction
```typescript theme={null}
interface CollectDataAction {
/** WebView URL for data collection */
url: string;
/** JSON schema describing required fields */
schema?: string;
}
```
## Error Handling
Handle errors gracefully in your payment flow:
```javascript theme={null}
try {
const options = await walletkit.pay.getPaymentOptions({
paymentLink,
accounts,
});
} catch (error) {
if (error.message.includes("payment not found")) {
console.error("Payment not found");
} else if (error.message.includes("expired")) {
console.error("Payment has expired");
} else {
console.error("Payment error:", error);
}
}
```
## Best Practices
1. **Use WalletKit Integration**: If your wallet already uses WalletKit, prefer this approach for automatic configuration
2. **Use `isPaymentLink()` for Detection**: Use the utility function instead of manual URL parsing for reliable payment link detection
3. **Account Format**: Always use CAIP-10 format for accounts: `eip155:{chainId}:{address}`
4. **Multiple Chains**: Provide accounts for all supported chains to maximize payment options
5. **Signature Order**: Maintain the same order of signatures as the actions array
6. **Error Handling**: Always handle errors gracefully and show appropriate user feedback
7. **Loading States**: Show loading indicators during API calls and signing operations
8. **Expiration**: Check `paymentInfo.expiresAt` and warn users if time is running low
9. **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.
10. **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.