Canonical, language-agnostic specifications for Nile Squad products. This is the source of truth a developer reads to implement an official SDK or integration in any language, the published packages are reference implementations of what lives here.
Each spec defines the API surface, types, behaviors, transport contract, and invariants that every implementation must follow. If a spec and an implementation disagree, the spec wins; the spec is updated first, then implementations follow.
| Product | Spec | What it is | Reference implementation |
|---|---|---|---|
| Nylon Pay | nylonpay-sdk-spec/ |
Server-side SDK for collecting payments, payouts, phone verification, invoices, transaction status, and webhook verification over a signed, action-based transport. | nylonpay-ts (TypeScript) |
- Start with the Build Guide: the recipe listing the components and the order to build them in, with a verify step at the end of each stage.
- Read the spec end to end, principles, decision records, operations, types, transport contract, security, invariants, and prohibitions.
- Match names, shapes, events, and status values exactly. Only casing adapts to
each language's conventions (
collectPayment/collect_payment/CollectPayment). - Use the reference implementation to resolve ambiguity, then mirror its public surface, not its internal structure.
- Ship the test suite the spec requires (signing, response verification, lifecycle, retries, webhook verification, and the listed edge cases).
Specs are versioned independently (see the Version field in each spec, which
points at the spec's changelog). Breaking
changes bump the major version and are recorded there.