API Reference

Authentication

Authenticate requests to the WalletConnect Pay API with API keys.

Every request to the WalletConnect Pay API is authenticated with an API key, passed in the Api-Key header:

curl "https://api.pay.walletconnect.com/v1/merchants" \
  -H "Api-Key: $WCP_API_KEY"

API keys are created and managed in the dashboard. A key is shown only once at creation — store it in a secret manager. Anyone with the key can act on behalf of your account.

Test and live keys

Your account has two kinds of keys, one for each mode:

Key prefixModeBehavior
wcp_test_TestPayments are simulated; no funds move. See Test mode.
wcp_LiveReal payments with on-chain settlement.

The key is the only thing that selects test or live. Both key types work against the same base URL and the same endpoints, and there is no test flag or mode parameter on any request.

Responses do not say whether a resource is test or live — that's determined by the key that created it.

Errors

StatusMeaning
401 UnauthorizedThe key is missing, malformed, or revoked.
403 ForbiddenThe key is valid but lacks permission for this account or resource.

Key safety

  • Never expose keys in client-side code. All API calls should be made from your backend.
  • Use test keys everywhere except production. Development, CI, and staging should use wcp_test_ keys.
  • Rotate compromised keys immediately from the dashboard.

On this page