# FloatPay

> White-label payment gateway. REST API under /api/v1, TypeScript SDK, hosted Checkout.

## Docs

- [Quickstart](https://float-pay.com/docs/start.md): A working charge in four steps, against Test Mode.
- [Authentication](https://float-pay.com/docs/auth.md): One credential, one organization, one mode — scopes, expiry, IP allowlist.
- [Collecting a card](https://float-pay.com/docs/tokenize.md): FloatPay never accepts card numbers over the API — payment_token or customer_vault_id only.
- [Charging, and the money actions](https://float-pay.com/docs/charge.md): Authorize now and capture later, or charge outright — refund and void the same way.
- [Checkout Sessions](https://float-pay.com/docs/checkout.md): Create a hosted pay page on your server, redirect the customer, read the answer back.
- [Payment Links](https://float-pay.com/docs/payment-links.md): One URL that sells — no site of your own, no card form, no redirect handler.
- [Coupons & promotion codes](https://float-pay.com/docs/coupons.md): Percent or amount off, on Payment Links and Checkout — the customer types the code, you never compute the discount.
- [Invoices](https://float-pay.com/docs/invoices.md): Bill someone who is not at a checkout — draft, finalize, send, get paid on a branded page.
- [Idempotency](https://float-pay.com/docs/idempotency.md): Required on every POST, not optional — a timed-out request cannot be told apart from a decline.
- [Webhooks](https://float-pay.com/docs/webhooks.md): Register a URL, verify one header, and act on events as they happen instead of polling.
- [Events](https://float-pay.com/docs/events.md): The same log a webhook endpoint is fed from, readable directly.
- [Testing](https://float-pay.com/docs/testing.md): Named sandbox triggers, firing a test event, and streaming events live.
- [CLI](https://float-pay.com/docs/cli.md): floatpay login, listen, and trigger — a local webhook receiver with no tunnel.
- [Errors](https://float-pay.com/docs/errors.md): One error shape for every non-2xx response — a decline is 402, never a server error.
- [API reference](https://float-pay.com/docs/reference.md): Every /v1 endpoint — transactions, checkout sessions, customers, products, prices.
- [Things to know](https://float-pay.com/docs/gotchas.md): Gateway-local timestamps, page-based pagination, the rate limit, and what is not in v1 yet.

## API

- [OpenAPI spec](https://float-pay.com/docs/openapi.json): The full machine-readable /v1 contract (OpenAPI 3.1).