Skip to main content
The Payoes API is a REST JSON API for creating and managing Stellar payments, customers, and billing resources.

​
Base URL

All public integration endpoints are under /api/v1.

​
Authentication

See Authentication for key management and rotation.

​
Environments

API keys are scoped to a single environment: List and retrieve operations only return resources created in the same environment as the API key. Sandbox and production data are fully isolated. See Environments for dashboard mode switching and settlement wallets.

​
Request format

  • Send JSON bodies with Content-Type: application/json
  • Use snake_case field names in request and response bodies
  • Amounts are strings with up to 7 decimal places (Stellar convention)

​
Response format

Successful responses return JSON objects. List endpoints wrap resources in a plural key (for example payments, customers). Errors return:

​
Object types

Resources include an object field for identification:

​
Available endpoints

​
Payments

​
Customers

​
Checkout sessions

Checkout sessions are created when you finalize an invoice or when a customer visits a payment link.

​
Invoices

Invoices can also be created with line items and sent by email from the dashboard. The hosted invoice page is available at /i/{invoice_id} after finalize. Full request and response schemas are in the endpoint sections of this API reference, generated from apps/docs/openapi/v1.yaml.

​
Hosted URLs

​
Rate limiting

Rate limits are not enforced in the current release. Production deployments should implement limits. Check release notes for updates.

​
Idempotency

Idempotency keys are planned. Until then, use unique metadata values and guard webhook handlers against duplicate processing.

​
Changelog