Changelog

API Changelog

Version 1.1.0 (Current)

Released: 2026

New Features

Payment Method Selection

• New paymentMethods field when creating payment links
• Accepts an array of "yappy" and/or "card"
• Validates that specified methods are active on the account
• New error code ERR_INACTIVE_PAYMENT_METHOD when a method is not active

Request Customer Email

• New requestCustomerEmail field when creating payment links
• When true, the hosted payment page prompts the customer for their email
• Defaults to true when omitted
• Cannot be true when customerEmail is already provided

Payment Provider Filter

• New paymentProvider query parameter on GET /v1/payment-links
• Filter by provider: nmi, emetec, or yappy

Updated Response Fields

• Payment link responses now include paymentMethods and requestCustomerEmail fields
• Cancel endpoint returns a compact response: hashUrl, customerName, concept, amount, status, createdAt, cancelledAt

Webhook Payload Updates

• transaction.isTest field added to payment.success webhook events

---

Version 1.0.0

Initial Release

Released: 2025

Features

• Payment link management (create, list, retrieve, cancel)
• API key authentication with rate limiting (60 requests/min)
• Webhook support for payment.success and webhook.ping events
• Metadata support (up to 20 keys, 8KB total)
• Test mode for sandbox testing

API Endpoints

Public API (API Key Auth)

• GET /v1/payment-links - List payment links
• GET /v1/payment-links/{hashUrl} - Retrieve payment link
• POST /v1/payment-links - Create payment link
• PATCH /v1/payment-links/{hashUrl}/cancel - Cancel payment link

Pagination

• Uses lim (limit) and off (offset) parameters
• lim: Positive integer for page size
• off: Non-negative integer for offset

Validation Rules

• Amount: 100-200,000 cents ($1.00-$2,000.00)
• Concept: Required, non-empty string
• Customer Name: Required, non-empty string
• Customer Email: Optional, valid email format
• Request Customer Email: Optional boolean, defaults to true, cannot be true with customerEmail
• Redirect URL: Optional, valid URL, max 2048 characters
• Metadata: Optional, max 20 keys, key length 1-40 chars, max 8KB total, cannot be empty object if provided
• Payment Methods: Optional array of "yappy" / "card", no duplicates, at least 1 when specified

Rate Limiting

• 60 requests per minute per API key
• Headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset

Webhooks

• HTTPS only
• HMAC-SHA256 signature verification
• Up to 6 retry attempts with exponential backoff
• Headers: Zeltapay-Signature, Zeltapay-Timestamp, Zeltapay-Event-Id, Zeltapay-Event-Type, Zeltapay-Delivery-Attempt

Response Format

All API responses follow a consistent JSON structure:

• Success responses include success: true, data, optional message, and timestamp
• Error responses include success: false, message, error object with code and optional details, and timestamp

HTTP Status Codes

• 200 OK - Request successful
• 201 Created - Resource created successfully
• 400 Bad Request - Invalid request data or validation error
• 401 Unauthorized - Missing or invalid API key
• 403 Forbidden - Account suspended
• 404 Not Found - Resource not found
• 429 Too Many Requests - Rate limit exceeded
• 500 Internal Server Error - Server error

Known Issues

None

---

Future Versions

Future API changes and new versions will be documented here. Breaking changes will be introduced under new version paths (e.g., /v2/payment-links).