Skip to main content
This guide walks you through creating your first payment in under 5 minutes.

Prerequisites

Merchant Account

A CeyPay merchant account (sign up here)

KYC Verification

Completed merchant onboarding and KYC verification

Programming Language

Your preferred programming language (Node.js, Python, PHP, etc.)

Base URL

Production

Live environment for real transactions

Sandbox

Test environment for integration testing
Getting StartedIf you want to integrate CeyPay without signing up for a sandbox account, use the sandbox API key below.Sandbox API Key:
Remember: The x-api-key header should contain ONLY the key ID (the part before the dot), NOT the full API key. The secret key is used locally to derive the signing key and is never transmitted.

Get Started

1

Generate API Key

  1. Log in to your CeyPay Dashboard
  2. Navigate to SettingsAPI Keys
  3. Click Generate New API Key
  4. Give it a descriptive name (e.g., “Production API Key”)
  5. Copy the API key immediately (you’ll only see it once!)
Your API key looks like: ak_live_abc123xyz.sk_live_def456uvw
  • ak_live_abc123xyz - Public key ID (sent in x-api-key header)
  • sk_live_def456uvw - Secret key (used locally to derive signing key, NEVER transmitted)
Important: Store your API key securely (environment variable, secrets manager, etc.)
2

Make Your First API Call

Create a Payment

Let’s create a simple payment for $100 USDT:

Response

Save the id and qrContent from the response. You’ll need them to direct customers to payment.
3

Direct Customer to Payment

You have two options to collect payment:

Redirect to Checkout

Redirect users to the hosted checkout page:

Display QR Code

Show a QR code for mobile wallet scanning:
4

Handle Webhook Notifications

Set up a webhook endpoint to receive payment status updates. CeyPay uses ED25519 signatures for security.
See webhooks.md for complete webhook integration guide.

Step 5: Test Your Integration

Test Webhook Endpoint

Test Payment Flow

1

Create a test payment

2

Open the checkout link in your browser

3

Complete the payment (use Bybit test account if available)

4

Verify webhook is received

5

Check payment status via API

Common Use Cases

E-commerce Checkout

Invoice Payment

Next Steps

Learn More

Authentication

Deep dive into HMAC signature

Webhooks

Complete webhook integration guide

Payment Links

Guide to using payment links

Error Handling

Error codes and troubleshooting

Rate Limits

API rate limiting policies

Explore API Endpoints

Payments:
  • POST /v1/payment - Create payment
  • GET /v1/payment/:id - Get payment details
  • GET /v1/payment - List payments
Payment Links:
  • POST /v1/payment-link - Create payment link
  • GET /v1/payment-link/:id - Get payment link
  • GET /v1/payment-link - List payment links
  • PATCH /v1/payment-link/:id - Update payment link
  • DELETE /v1/payment-link/:id - Deactivate payment link
Webhooks:
  • GET /v1/webhooks/config - Get webhook configuration
  • POST /v1/webhooks/test - Test webhook delivery

API Reference

Full API documentation available at: https://api.ceypay.io/api-docs

Support

Checklist

Before going live, ensure you:
  • Completed merchant onboarding and KYC
  • Generated production API key
  • Stored API key securely (environment variable)
  • Implemented HMAC signature authentication with derived signing key
  • Set up webhook endpoint with signature verification
  • Tested payment flow end-to-end
  • Implemented error handling
  • Configured monitoring and logging
  • Reviewed security best practices
  • Read rate limiting policies

Tips

Security

  • Never commit API keys to version control
  • Use environment variables for secrets
  • Always verify webhook signatures
  • Use HTTPS for all webhook endpoints
  • Send only the key ID in x-api-key, never the full API key

Performance

  • Cache exchange rates when possible
  • Implement idempotent webhook handling
  • Use exponential backoff for retries
  • Monitor rate limit headers

Testing

  • Use ngrok for local webhook testing
  • Create test payments regularly
  • Monitor webhook delivery logs
  • Set up alerts for failed webhooks
Happy coding!