Rekaz Developer Platform
APIs and webhooks for building integrations with Rekaz.
Use the Rekaz Merchant API to read the public catalog and transaction history, manage customers, create reservations and subscriptions, generate Rekaz-hosted checkout links, and receive signed business webhooks.
Public API URL
All merchant public endpoints use https://platform.rekaz.io/api/public.
Authentication
Every request requires Basic authentication, the __tenant header, and Accept: application/json. Build the Basic value from the API key and secret. Keep both credentials on your backend and never embed them in a browser or mobile application.
Read transactions
Use GET https://platform.rekaz.io/api/public/transactions to list non-draft transactions. Use GET https://platform.rekaz.io/api/public/transactions/{id} to fetch one transaction.
Each transaction includes customer details, totals, currency, items, payments, CreatedAt, and UpdatedAt. Enum fields such as status, paymentStatus, source, payment type, payment status, and payment method are returned as readable strings. All date-time values are UTC.
The list endpoint supports CreatedMin, CreatedMax, UpdatedMin, UpdatedMax, Statuses, PaymentStatuses, CustomerId, BranchId, TransactionNumber, SortBy, SortDirection, SkipCount, and MaxResultCount. MaxResultCount is limited to 100.
Incremental transaction sync
For the first import, sort by UpdatedAt in ascending order and read every page. Store the greatest UpdatedAt value only after processing the complete result set.
For later imports, send that value as UpdatedMin, keep SortBy set to UpdatedAt and SortDirection set to Asc, and page with SkipCount and MaxResultCount. UpdatedMin is inclusive, so the last timestamp can appear again. Make processing idempotent and deduplicate by transaction Id and UpdatedAt.
Creating, editing, or deleting a pending payment changes the parent transaction UpdatedAt value, so incremental sync will see the change.
Transaction webhooks
TransactionCreatedEvent, TransactionUpdatedEvent, TransactionPaidEvent, TransactionRefundedEvent, and TransactionCancelledEvent provide near-real-time notifications. TransactionUpdatedEvent also covers pending payment creation, editing, and deletion.
Webhook deliveries include X-Rekaz-Signature. Verify HMAC-SHA256 over the exact raw request body before processing. The signing secret is available in Settings > API Keys > Webhook. See https://docs.rekaz.io/docs/webhooks for the full receiver and rotation rules.
Integration scope
The merchant API is a server-to-server API. Rekaz returns hosted checkout URLs where applicable. The merchant API does not expose card-processing, refund, invoice-retrieval, or externally-paid endpoints.
Use https://docs.rekaz.io/docs/quick-start for a first authenticated request and https://docs.rekaz.io/reference for the full endpoint and request schemas.
Updated about 3 hours ago