Generated from the spec
TypeScript / Node
A zero-dependency BinkpayClient, generated from the API’s OpenAPI spec and typed end to end. Imported from source, not a registry package.
Developers · SDKs
Build with BINK.
Use the BINK API from the language your team already knows — a TypeScript client generated from the OpenAPI spec, a spec you can generate any language from, or plain REST underneath.
REST · JSONOpenAPI specTypeScript client
Request
curl https://binkpay.net/api/v1/developer/ping \
-H "Authorization: Bearer sk_test_51H..."Response200 OK
{
"ok": true,
"companyId": "co_4b7e21",
"livemode": false,
"scopes": ["analytics:read", "payments:read"]
}The developer probe — the one endpoint that accepts an API key today. Display and copy only; no live request is sent.
How you integrate
Three honest paths.
BINK does not publish per-language packages. This is what actually ships today.
Generate from the spec
Any language
No official package ships for other languages yet. Generate a client for yours from the same OpenAPI spec with openapi-generator.
Available now
REST API
No SDK required. The API is plain REST over HTTPS, JSON in and out — call it with the tools your team already uses.
TypeScript client
Typed, and generated from the spec.
The TypeScript client is generated from the API’s OpenAPI spec, so its methods and types track the API. It carries no dependencies and uses the platform-native fetch. Instantiate it with your key; it sends the key as a Bearer token.
TypeScript
import { BinkpayClient } from "./sdk/typescript";
// Zero-dependency, generated from the OpenAPI spec.
const binkpay = new BinkpayClient({
apiKey: "sk_test_51H...",
});Before your first call
Authentication and environments.
Authentication
BINK authorises by session + API key. An sk_ key works on the developer probe today; the resource endpoints authorise by your dashboard session. Send the key as a Bearer token.
Environments
Every account has a test pair (sk_test_) and a live pair (sk_live_). The key encodes the mode — same base URL /api/v1, no separate host to switch.
Recommended path
From key to production.
Authenticate
Send your key as a Bearer token; every response carries a requestId.
Create a request
REST over HTTPS, JSON body, one prefix — /api/v1.
Handle the response
One predictable shape and one error envelope across every resource.
Listen for webhooks
Verify the signature on each event and react — no polling.
Move to production
Swap the sk_test_ key for sk_live_. No base URL to change.
Event-driven, not polled.
Webhook events let your system respond to changes without polling. Every delivery is signed with HMAC-SHA256 — verify it and react.
Developer portal
The rest of the platform.
API ReferenceREST resources and the request/response contract.SDKs ·Typed clients for the API.SandboxTest keys and simulated events, isolated from production.WebhooksSigned event delivery, retries and replay.DocumentationGuides, quickstarts and integration patterns.API StatusLive system health.ChangelogRelease notes and breaking changes.
SDKs
Start with the reference.
The exact endpoints, the request shape and the error envelope — then generate a client, or call the API directly.