Skip to content

API Reference

CyberPay provides two sets of HTTP APIs:

ServiceBase URLDescription
Core APIhttps://api.cyberpay.orgPayment core: Checkout, Order, PayLinks, Dashboard
Service APIhttps://service.cyberpay.orgValue-added services: Virtual cards, SMS, Email, Gift cards, Payout
CyberNanoPayhttps://gateway.cyberpay.orgx402 nano-payment gateway

Authentication

Core API uses the x-wallet header to pass wallet address for identity:

curl -H "x-wallet: 0xYourWalletAddress" https://api.cyberpay.org/api/keys

API Key authentication (for server-side integration):

curl -H "Authorization: Bearer cpk_xxx" https://api.cyberpay.org/api/v1/pay/quote

Service API requires no authentication, call directly.

Route Structure

Core API:
  /api/v1/pay/*          — Unified payment (Quote, Order, Checkout)
  /api/v1/swap/*         — Cross-chain Swap
  /api/v1/merchant/*     — Merchant payments
  /api/v1/payment/*      — Payment execution
  /api/v1/agent/*        — AI Agent Chat
  /api/settings          — Merchant settings
  /api/keys              — API Key management
  /api/paylinks          — Payment links
  /api/overview          — Dashboard overview
  /api/transactions      — Transaction records
 
Service API:
  /card/*                — CyberCard virtual cards
  /sms/*                 — CyberSMS verification codes
  /email/*               — CyberMail disposable inbox
  /agentmail/*           — CyberMail professional email
  /resend/*              — CyberMail custom domain sending
  /gift/*                — CyberGift gift cards / top-up / bills
  /payout/*              — CyberPayout batch transfers
  /catalog               — Service catalog
 
CyberNanoPay:
  /verify                — x402 payment verification
  /balance/:address      — Balance query
  /stats                 — Statistics
  /attestation           — TEE attestation
  /policy                — Policy management