Back to Changelog
January 27, 2026documentation

API Documentation Accuracy Update

Comprehensive update to API documentation ensuring all schemas match the actual backend implementation.

We've conducted a thorough review and update of our API documentation to ensure accuracy across all endpoints, webhooks, and code examples.

Key Updates

Request/Response Schemas

  • Correct field names: Response uses paymentId (not id) and generatedAddress (not address)
  • Required fields: Payment creation now clearly documents amount, currency, and network as required
  • Status values: All statuses are lowercase (pending, confirmed, underpaid, overpaid, expired, failed, canceled)
  • New status: Added underpaid and overpaid statuses to handle partial payments
  • Authentication Headers

  • Correct header names: X-Pulse2Pay-Key, X-Pulse2Pay-Signature, X-Pulse2Pay-Timestamp
  • Timestamp format: Now clearly documented as milliseconds (not seconds)
  • API key prefix: Public keys use pk_live_ / pk_test_, secret keys use sk_live_ / sk_test_
  • Webhook Documentation

  • Signature format: Webhook signatures use timestamp.body (different from API signature format)
  • Payload structure: Uses type field (not event) and wraps payment data in data object
  • Retry policy: Updated to 5 attempts with delays of 1s, 5s, 30s, 1min, 5min
  • All 8 events: payment.created, payment.pending, payment.confirmed, payment.underpaid, payment.overpaid, payment.expired, payment.failed, payment.canceled
  • New Features Documented

  • Webhook payload fields: externalId, differenceAmount, overpaidAmount, underpaidAmount, alertType
  • Integration Checklist: Added to merchant portal for easier onboarding
  • Updated Resources

  • API Reference
  • Webhooks Documentation
  • API Authentication Guide
  • Webhook Security Guide
  • Accept USDT Payments
  • Crypto Checkout Flow
#api#documentation#webhooks#integration