Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.48 KB

File metadata and controls

33 lines (24 loc) · 2.48 KB

Heleket Node.js integration — documentation

This documentation set covers everything you need to integrate Heleket from a Node.js application. Written for both TypeScript merchants and pure-JS merchants — the SDK exposes the same JavaScript runtime in both cases, with .d.ts files providing types where they're wanted.

How to read this

Start with Installation and Configuration, then either jump into Payments (most common starting point) or read Architecture first if you prefer top-down explanation. Webhooks is the most security-sensitive chapter — read it before going to production.

Table of contents

Chapter When to read
01 — Installation Once, when setting up
02 — Configuration Once, plus when tuning timeouts/debug/transport
03 — Architecture When you want to know how the SDK is put together
04 — Payments API Reference for every payment endpoint
05 — Payouts API Reference for every payout endpoint
06 — Webhooks Read before production
07 — Debugging When something doesn't work
08 — Testing When you want to write tests against the SDK
09 — Error handling When designing your error-recovery strategy
10 — Reference Lookup table for statuses, currencies, endpoints
12 — Troubleshooting When stuck

Conventions

  • Code blocks marked ts are TypeScript. The same code (without type annotations) runs as plain JS — the SDK ships compiled .js so you don't need a TS toolchain to use it.
  • Endpoint paths are shown relative to the API base URL (https://api.heleket.com).
  • Square brackets indicate optional parameters; everything else is required.

Upstream documentation

This SDK wraps the official Heleket API documented at https://doc.heleket.com. When in doubt about API semantics, the official docs are authoritative.