Business Payments developer guide
Use server-side merchant APIs to collect payments and inspect outcomes, then integrate notifications, refunds and fund collection when those capabilities are enabled. A Checkout is a collection session associated with your business order and its cashier URL. Task guides explain the workflow; resource and operation references contain exact fields.
Start with merchant payment terms to distinguish orders, Checkouts and payment items.
Complete a payment flow first
Prepare your server → create a Checkout → share its cashier URL → retrieve status server-side → fulfill once per order.
A payer returning to your site is not proof of payment. Base the current integration on resource retrieval; pending Webhooks cannot be its only notification channel.
| Task | Guide | Reference |
|---|---|---|
| Inspect payment methods and create a Checkout | First payment | Methods, create Checkout |
| Handle outcomes and exceptions | States and exceptions | Retrieve Checkout |
| Deliver goods, content or service | Confirmation and fulfillment | List Checkouts |
| Receive events | Webhooks | Endpoints and events, availability pending |
| Refund goods, differences or duplicates | Refund flow | Payment details, refunds, availability pending |
| Collect IPP funds into a wallet | Settlement flow | Items and tasks, execution support pending |
Confirm available capabilities
API availability distinguishes Merchant route confirmed, Execution support pending and Availability pending. Confirm the target environment and your account support each required operation. The current minimum flow is creation, retrieval and order reconciliation.
Amounts are currency-unit decimal strings: "10" means 10 USDC. Merchant developers do not manage ZK proofs or protocol credentials. For direct protocol integration or self-hosted Facilitator, use Open Protocol; its native interfaces are separate from this merchant API.
Complete testing and readiness before production. Illustrative responses are not actual payment outcomes.