Guides
Getting started
Klustar Payment APIs let you collect payments (payins) and send money to bank accounts (payouts). Every sensitive payment request is signed with HMAC-SHA256 using credentials from your merchant dashboard.
- 1
Create a merchant account
Sign up on the merchant portal, verify your email with the one-time code, and complete business onboarding.
Create account → - 2
Generate API credentials
Open Dashboard → Settings → API Keys. Copy your API key, secret key, and merchant ID into environment variables — never hard-code secrets in apps or public docs.
Open API settings → - 3
Sign your first request
Follow the Authentication guide to build the canonical body, HMAC signature, and required headers, then call Create a payin in sandbox.
Read authentication →
Popular endpoints
Base URLs
| Service | URL |
|---|---|
| Payment API | https://payment.klustar.io |
| Merchant portal API | https://merchant.klustar.io |
Glossary
- appId
- Unique identifier of your business profile; same as businessProfile.id from login.
- merchantId
- Alias of appId used in payin and payout headers (X-Merchant-ID).
- apiKey / secretKey
- Public/private credential pair. The secret signs requests and must never appear in clients or public docs.
- reference
- Your unique transaction reference. Echoed back in callbacks and status queries.
- orderNo / payId
- Klustar's internal IDs for the transaction; useful for support enquiries.
- tenant
- Multi-tenant identifier passed as X-Tenant-ID.
- notifyUrl
- Your webhook endpoint for asynchronous transaction updates.
Need a Postman collection? Email support@klustar.io.