0Bit public documentation
API reference overview
Gate hosts, authentication, resources, and request conventions.
Gate's public API is unversioned. Route paths begin directly with the resource name.
| Environment | Base URL |
|---|---|
| Sandbox | https://gate-api-sandbox.0bit.app |
| Production | https://gate-api.0bit.app |
Do not append a version segment. A test key belongs on the sandbox host and a live key belongs on the production host.
Public partner resources
| Area | Routes | Credential |
|---|---|---|
| Sessions | /gate_sessions |
sk_* |
| Capabilities | /capabilities/* |
sk_* |
| Quote preview | /quotes/preview |
sk_* |
| Signed quotes | /quotes, /quotes/{id} |
sk_* plus rails entitlement |
| Rails | /rails/pay_ins*, /rails/pay_outs* |
sk_* plus rails entitlement |
| Transactions | /transactions* |
sk_* |
| Customers | /customers* |
sk_* |
| Branding | /branding |
sk_* |
| Widget bootstrap | /embed/bootstrap |
pk_* |
| Partner dashboard | /dashboard/*, /webhooks/test |
sk_* or Account assertion |
The exact 37 callable operations, request bodies, responses, and 23 webhook event contracts are in openapi/gate.yaml.
Conventions
- JSON request and response bodies use
snake_case, except widget bootstrap'sclientSecret, which matches the browser SDK contract. - Monetary values are decimal strings. Do not send binary floating-point values.
- Dates are ISO 8601 UTC strings unless a webhook field explicitly uses Unix epoch seconds.
- Partner-owned resources are scoped by the credential. A cross-partner lookup is unavailable to the caller.
- List endpoints use their declared query parameters; do not assume a universal pagination shape.
- Send
Content-Type: application/jsonfor JSON bodies. - Use
Idempotency-Keyonly where the operation declares it.
Use the capabilities endpoints at runtime. Static documentation cannot determine what a particular partner, mode, country, currency, or entitlement can use.
