One REST API.
Every BINK payment rail.
Payments, payouts, refunds, cards, customers and invoices — one request shape, one error envelope, one idempotency contract. Signed webhooks keep your system in sync without polling.
Everything before your first call.
The facts every integration needs up front — base URL, auth, idempotency, and how errors and limits are shaped.
binkpay.net/api/v1
Every route in the API Reference is served under this one prefix.
Session + API key
Payments, Payouts, Refunds, Cards, Customers and Invoices authorize by dashboard session today; sk_/pk_ API keys already work on the developer probe endpoint.
requestId
Every response — success or error — carries a requestId to reference when contacting support.
Idempotency-Key
Pass this header on POST /merchant/payments to make retries safe.
{ ok, statusCode, message }
One error envelope across every endpoint — validation, auth, and server faults alike.
600 req / min
Default per-user ceiling, with tighter limits on sensitive endpoints like login.
Confirm your key.
See your environment.
The developer probe is the one endpoint on this reference that accepts an sk_ API key today — it confirms the key works and reports which company and environment it belongs to.
curl https://binkpay.net/api/v1/developer/ping \
-H "Authorization: Bearer sk_test_51H..."{
"ok": true,
"companyId": "co_4b7e21",
"livemode": false,
"scopes": ["analytics:read", "payments:read"]
}Nine resources. One coherent contract.
Every resource shares the same auth model, error envelope and idempotency contract — read the full reference for parameters, requests and responses.
Create, list, retrieve, and cancel payments — the object behind Hosted Checkout and Payment Links.
Read the referenceCheck available balance and request an off-cycle payout to your linked bank account.
Read the referenceIssue and list refunds against paid payments.
Read the referenceIssue, list, fund, freeze and control cards.
Read the referenceCustomer records derived automatically from payment activity.
Read the referenceLine-itemized bills for manual, out-of-band payment.
Read the referenceSigned event delivery, retry policy, and the full event catalog.
Read the referenceThe shared error envelope and HTTP status codes.
Read the referenceRequest limits, the Idempotency-Key header, and 429 handling.
Read the referenceThe rest of the ecosystem.
Everything else you need to build, test and operate an integration.
REST endpoints, resources, and the request/response contract.
SDKsTyped clients generated from the platform.
SandboxTest keys and simulated events — no production data at risk.
WebhooksSigned delivery, retry policy, event catalog.
DocumentationGuides, quickstarts, and integration patterns.
API StatusLive system health, per region.
ChangelogRelease notes and breaking changes.