This quickstart begins with testnet configuration for safe testing. When you’re ready for production, see Running on Mainnet for the simple changes needed to accept real payments.
Prerequisites
Before you begin, ensure you have:- A crypto wallet to receive funds (any EVM-compatible wallet, e.g., CDP Wallet)
- (Optional) A Coinbase Developer Platform (CDP) account and API Keys
- Required for mainnet use until other facilitators go live
- Node.js and npm, or Python and pip installed
- An existing API or server
We have pre-configured examples available in our repo for both Node.js and Python. We also have an advanced example that shows how to use the x402 SDKs to build a more complex payment flow.
1. Install Dependencies
Install the x402 Express middleware package:
The mainnet facilitator packages (
@coinbase/x402
for Node.js, cdp
for Python) are only needed for production. For testnet development, you can skip these. See Running on Mainnet for details.2. Add Payment Middleware
Integrate the payment middleware into your application. You will need to provide:- The Facilitator URL or facilitator object. For testing, use
https://x402.org/facilitator
which works on Base Sepolia.- For mainnet setup, see Running on Mainnet
- The routes you want to protect
- Your receiving wallet address
The examples below show testnet configuration. When you’re ready to accept real payments, refer to Running on Mainnet for the simple changes needed.
Full example in the repo here.
Ready to accept real payments? See Running on Mainnet for production setup.
3. Test Your Integration
To verify:- Make a request to your endpoint (e.g.,
curl http://localhost:3000/your-endpoint
). - The server responds with a 402 Payment Required, including payment instructions in the body.
- Complete the payment using a compatible client, wallet, or automated agent. This typically involves signing a payment payload, which is handled by the client SDK detailed in the Quickstart for Buyers.
- Retry the request, this time including the
X-PAYMENT
header containing the cryptographic proof of payment (payment payload). - The server verifies the payment via the facilitator and, if valid, returns your actual API response (e.g.,
{ "data": "Your paid API response." }
).
4. Enhance Discovery with Metadata (Recommended)
When using the CDP facilitator, your endpoints are automatically listed in the x402 Bazaar, our discovery layer that helps buyers and AI agents find services. To improve your visibility and help users understand your API:Include descriptive metadata in your middleware configuration:
description
: Clear explanation of what your endpoint doesinputSchema
: JSON schema describing required parametersoutputSchema
: JSON schema of your response format
- AI agents automatically understand how to use your API
- Developers quickly find services that meet their needs
- Improve your ranking in discovery results
5. Error Handling
- If you run into trouble, check out the examples in the repo for more context and full code.
npm install
the dependencies in each example
Running on Mainnet
Once you’ve tested your integration on testnet, you’re ready to accept real payments on mainnet. Here’s what you need to do:1. Set up CDP API Keys
To use the mainnet facilitator, you’ll need a Coinbase Developer Platform account:- Sign up at cdp.coinbase.com
- Create a new project
- Generate API credentials
- Set the following environment variables:
2. Update Your Code
Replace the testnet configuration with mainnet settings:3. Update Your Wallet
Make sure your receiving wallet address (0xYourAddress
) is a real mainnet address where you want to receive USDC payments.
4. Test with Real Payments
Before going live:- Test with small amounts first
- Verify payments are arriving in your wallet
- Monitor the facilitator for any issues
Mainnet transactions involve real money. Always test thoroughly on testnet first and start with small amounts on mainnet.
Next Steps
- Looking for something more advanced? Check out the Advanced Example
- Get started as a buyer
Summary
This quickstart covered:- Installing the x402 SDK and relevant middleware
- Adding payment middleware to your API and configuring it
- Testing your integration