# Plane Business

> API documentation for integrating business accounts, cards, and card operations with Plane Business.

- [Plane Business API](https://docs.planewallet.org/index.md): Build card and service integrations for your company.
- [Quickstart](https://docs.planewallet.org/quickstart.md): Make your first authenticated request.
- [Authentication](https://docs.planewallet.org/authentication.md): Company-scoped keys and explicit permissions.
- [Environments](https://docs.planewallet.org/environments.md): Develop against isolated sandbox resources.
- [Issue your first card](https://docs.planewallet.org/issue-card.md): Create a holder, quote the price, and track an asynchronous card issuance.
- [Top up a card](https://docs.planewallet.org/card-topups.md): Quote a top-up, reserve funds, and confirm the credited result.
- [Freeze and unfreeze](https://docs.planewallet.org/card-controls.md): Control a card while keeping its actual status visible.
- [Card details](https://docs.planewallet.org/card-details.md): Choose direct server access or a hosted view.
- [Operation lifecycle](https://docs.planewallet.org/operation-lifecycle.md): Track completion and retry without duplicating operations.
- [Webhooks](https://docs.planewallet.org/webhooks.md): Verify event signatures and process events without duplicate effects.
- [Wallet and card account funding](https://docs.planewallet.org/funding.md): Transfer USDT directly to an issuer invoice and fund a separate card account.
- [Individual and corporate verification](https://docs.planewallet.org/verification.md): Unlock Live and API access with the verification tier that fits your use.
- [Account statements and transactions](https://docs.planewallet.org/account-statements.md): Reconcile card account movements independently from card purchases.
- [Errors and retries](https://docs.planewallet.org/errors.md): Decide whether to correct a request, wait, or reconcile an uncertain result.
- [Pagination and limits](https://docs.planewallet.org/pagination.md): Read operation history without skipping or duplicating records.
- [Go-live checklist](https://docs.planewallet.org/go-live.md): Validate your integration before requesting live activation.
- [Changelog](https://docs.planewallet.org/changelog.md): Changes to the public integration documentation.
- [Company balance](https://docs.planewallet.org/api-reference/get-balance.md): Required permission: `balance:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Quote a card account deposit](https://docs.planewallet.org/api-reference/post-card-account-quote.md): Required permission: `funding:write`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Create a card account invoice](https://docs.planewallet.org/api-reference/post-card-account-invoices.md): Required permission: funding:write. Idempotent. Transfer the exact payAmount of USDT on TRON to address before expiresAt. The issuer confirms settlement; never infer credit from a client transaction ID. Only one unresolved invoice is allowed per workspace/environment. Creating or ambiguous requests…
- [List card account invoices](https://docs.planewallet.org/api-reference/get-card-account-invoices.md): Required permission: `balance:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Get card account invoice](https://docs.planewallet.org/api-reference/get-card-account-invoices-id.md): Required permission: `balance:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [List card transactions](https://docs.planewallet.org/api-reference/get-transactions.md): Required permission: `operations:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Get a card transaction](https://docs.planewallet.org/api-reference/get-transactions-id.md): Required permission: `operations:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Generate an account statement](https://docs.planewallet.org/api-reference/get-account-statements.md): Required permission: balance:read. Both dates are inclusive UTC calendar dates. Maximum 366 days and 10,000 ledger entries; narrow the range if exceeded. Includes card-account deposits, fees, reservations and captures. Card purchase history is available separately under transactions.
- [Available product catalog](https://docs.planewallet.org/api-reference/get-products.md): Required permission: `services:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [List cardholders](https://docs.planewallet.org/api-reference/get-holders.md): Required permission: `holders:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Create cardholder](https://docs.planewallet.org/api-reference/post-holders.md): Required permission: `holders:write`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Update cardholder profile](https://docs.planewallet.org/api-reference/patch-holders-id.md): Required permission: holders:write. Updating a live holder profile requires a new verification review and is blocked while issuance is pending. Objects are scoped to the authenticated company and environment.
- [List masked cards](https://docs.planewallet.org/api-reference/get-cards.md): Required permission: `cards:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Freeze or unfreeze a card](https://docs.planewallet.org/api-reference/patch-cards-id.md): Required permission: `cards:write`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Get full card details](https://docs.planewallet.org/api-reference/post-cards-id-reveal.md): Required permission: `cards:read_sensitive`. Sandbox is isolated from live funds. Live integration availability is checked server-side. Server-to-server only. Do not log, cache or include this response in analytics. Responses use Cache-Control: no-store.
- [Create single-use hosted reveal session](https://docs.planewallet.org/api-reference/post-cards-id-view-sessions.md): Required permission: `cards:read_sensitive`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Calculate total price](https://docs.planewallet.org/api-reference/post-quotes.md): Required permission: `cards:read or services:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Issue/top up a card or order a service](https://docs.planewallet.org/api-reference/post-operations.md): Required permission: `cards:write or services:write`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [List company operations](https://docs.planewallet.org/api-reference/get-operations.md): Required permission: `operations:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Get operation status](https://docs.planewallet.org/api-reference/get-operations-id.md): Required permission: `operations:read`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Credit sandbox funds](https://docs.planewallet.org/api-reference/post-sandbox-funding.md): Required permission: `cards:write`. Sandbox is isolated from live funds. Live integration availability is checked server-side.
- [Complete a sandbox invoice](https://docs.planewallet.org/api-reference/post-sandbox-invoices-id-complete.md): Required permission: `funding:write`. Sandbox is isolated from live funds. Live integration availability is checked server-side.

## OpenAPI Specs

- [openapi](https://specs.planewallet.org/openapi.json)