llms.txt
WalletConnect Pay Docs
Documentation for WalletConnect Pay. Integrate secure crypto payments into your app with step-by-step guides, APIs, and best practices.
Docs
- WalletConnect Agents SDK
- Delete a merchant: Soft-delete a merchant. The merchant is hidden from listings and can no longer accept new payments. Already-deleted merchants return
deleted: trueso the call is idempotent. - Delete a crypto settlement: Remove a crypto settlement. Future payments in the deleted asset will no longer be auto-settled.
- Get a payment: This endpoint returns only basic information to display to the user to begin the payment flow.
- Get the payment status: Retrieves the status of a payment by its ID. Returns a polling delay to wait before checking the status again.
- List merchants: List the partner's merchants. Supports filtering by
status, free-textsearchover name and ID, and cursor-based pagination viacursorandlimit. - Get payments for a merchant: Deprecated: Use
GET /v1/merchants/paymentswith partnerapi-keyandmerchant-idheaders instead. - Get a merchant: Fetch a merchant's profile along with its configured
settlements(crypto and fiat). Crypto settlements use CAIP-19 asset IDs and CAIP-10 destination accounts. - List settlements: List the merchant's configured fiat and crypto settlement destinations.
- List payments for a merchant: Retrieve paginated payments with optional filters.
- List payments: Retrieve paginated payments with optional filters.
- Get payment details: Retrieves the full details of a payment by its ID, including settlement information when available.
- Get the payment status: Retrieves the status of a payment by its ID. Returns a polling delay to wait before checking the status again.
- Update a merchant: Update a merchant's profile. At least one of
merchantName,merchantEmail, oriconUrlmust be provided. PassiconUrl: nullto unset the existing logo. - POST /v1/gateway/payment/{id}/cancel
- Confirm a payment: This endpoint confirms a payment and submits it to the blockchain for processing.
- Fetches an action: This endpoint fetches an action for a payment.
- Get payment options: This endpoint takes a list of accounts and returns a list of options that can be used to complete the payment.
- Create a merchant: Create a new merchant under the authenticated partner. Requires an
Idempotency-Keyheader so retries safely return the originally-created merchant rather than creating duplicates. - Create crypto settlements: Register one or more crypto settlement destinations for the merchant. Each entry pairs a CAIP-19
assetwith a CAIP-10destinationwallet on the same chain. Each(merchant, asset)pair must be unique — register... - Create a new payment: Creates a new payment with the provided payment details.
- POST /v1/payments/{id}/cancel
- Mark a payment as refunded: Request a full refund for a payment. Calling a second time on the same payment returns 409.
- Update a crypto settlement destination: Change the destination wallet for an existing crypto settlement. The new
destinationmust be a CAIP-10 account on the same chain as the settlement'sasset. - Authentication: Authenticate requests to the WalletConnect Pay API with API keys.
- API Reference: Reference for the WalletConnect Pay API.
- API Versioning: How the WalletConnect Pay API is versioned using date-based versions, account pinning, and preview releases.
- CEX Exchange Integrations: Centralized exchanges supported by WalletConnect Pay, enabling users to pay directly from their CEX account balance.
- Merchant API Reference: API reference for the WalletConnect Pay Merchant API used in ecommerce checkout integrations.
- Online Checkout Integration Guide: Step-by-step guide to integrate WalletConnect Pay into your ecommerce checkout flow.
- WalletConnect Pay for Ecommerce and Online Checkout: Add crypto and stablecoin payments to your online checkout with a single API integration.
- Fiat Coverage: Fiat currencies supported by WalletConnect Pay for offramp settlement, with detail on how additional corridors are enabled.
- How to Pay with WalletConnect Pay
- Merchant logo specification: Required dimensions, formats, and file size for the iconUrl field on the Merchant API.
- Quickstart: Go from zero to your first payment with the WalletConnect Pay Merchant API in six steps.
- WalletConnect Pay
- How it works
- Implementation
- Headless SDK
- Packages Reference
- WalletConnect Pay for PSPs
- Test mode: Integrate and verify your WalletConnect Pay setup end to end without moving real funds.
- Token and Chain Coverage: Tokens and blockchains supported in General Availability within WalletConnect Pay, including acceptance and settlement options.
- Wallet Coverage
- API-first integration (Non-SDK wallets): Integrate WalletConnect Pay in a wallet without an SDK, using the Gateway API.
- WalletConnect Pay - Wallet Integration
- WalletConnect Pay SDK - Flutter: Integrate WalletConnect Pay into your Flutter wallet to enable seamless crypto payments for your users.
- WalletConnect Pay SDK - Kotlin: Integrate WalletConnect Pay into your Android wallet to enable seamless crypto payments for your users.
- WalletConnect Pay SDK - React Native: Integrate WalletConnect Pay into your React Native wallet to enable seamless crypto payments for your users.
- WalletConnect Pay SDK - Swift: Integrate WalletConnect Pay into your iOS wallet to enable seamless crypto payments for your users.
- WalletConnect Pay SDK - Web/Node.js: Integrate WalletConnect Pay into your Web/Node.js wallet to enable seamless crypto payments for your users.
- Tap to Pay - Wallet Integration Guide: Integrate Tap to Pay into your wallet app to enable contactless payments at POS terminals using WalletConnect Pay.
- Token & Chain Support: Guides for implementing specific token and blockchain support in your WalletConnect Pay wallet integration.
- Solana Support: Implement Solana payment capabilities in your wallet including native SOL transactions and mixed-chain payment options.
- USDT Support: Implement the two-action Permit2 flow your wallet needs to accept USDT and other ERC-20s without native typed-data authorization.
- WalletConnect Pay via WalletKit - Flutter: Integrate WalletConnect Pay through WalletKit for a unified payment experience in your Flutter wallet.
- WalletConnect Pay via WalletKit - Kotlin: Integrate WalletConnect Pay through WalletKit for a unified payment experience in your Android wallet.
- WalletConnect Pay via WalletKit - React Native: Integrate WalletConnect Pay through WalletKit for a unified payment experience in your React Native wallet.
- WalletConnect Pay via WalletKit - Swift: Integrate WalletConnect Pay through WalletKit for a unified payment experience in your iOS wallet.
- WalletConnect Pay via WalletKit - Web/Node.js: Integrate WalletConnect Pay through WalletKit for a unified payment experience in your Web/Node.js wallet.