API reference
Endpoints, request fields, response schemas and generated examples for every Kustom API.
Use Kustom’s APIs to create checkout orders, capture and refund payments and retrieve settlement reports. Choose an API in the sidebar for its endpoints, request fields, response schemas and examples.
Get started
Section titled “Get started”New to Kustom? Checkout in 15 minutes walks through creating an order, rendering Checkout and confirming a payment, with live calls against a Playground merchant.
Authentication and environments shows you how to create merchant API credentials in the Kustom Portal and send them using HTTP Basic auth. Partner onboarding uses OAuth 2.0 instead; follow the partner onboarding guide for its credentials and token flow.
Environments
Section titled “Environments”Build and test in the playground environment before taking real payments in production. Use the playground test data to try customer and payment scenarios without moving money.
| Environment | API host |
|---|---|
| Production | https://api.kustom.co |
| Playground | https://api.playground.kustom.co |
Append the endpoint path from the API reference to the host. Credentials belong to one environment and cannot be used in the other; see base URLs.
Request conventions
Section titled “Request conventions”- Requests and responses covers amounts, currencies, dates and identifiers.
- Errors explains response codes and error bodies.
- Limits describes request limits and how to handle them.
- Order Management retries explains how to retry those calls safely.
This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.