# Settlx

## Docs

- [API Conventions](https://docs.settlx.io/api-conventions.md): Request format, error handling, status codes, rate limits, and timestamps
- [List Chains](https://docs.settlx.io/api-reference/chains.md): Retrieve all supported blockchain networks and their tokens
- [Errors](https://docs.settlx.io/api-reference/errors.md): The Settlx API uses standard HTTP status codes. All error responses follow the same JSON structure.
- [Cancel Invoice](https://docs.settlx.io/api-reference/invoices/cancel.md): Cancel a pending invoice
- [Create Invoice](https://docs.settlx.io/api-reference/invoices/create.md): Create a new payment invoice
- [Get Invoice](https://docs.settlx.io/api-reference/invoices/get.md): Retrieve a single invoice by ID, including any generated payment addresses
- [List Invoices](https://docs.settlx.io/api-reference/invoices/list.md): Retrieve a paginated list of invoices for your merchant account
- [Get Invoice Status](https://docs.settlx.io/api-reference/invoices/status.md): Public polling endpoint for invoice payment status
- [Create Payment](https://docs.settlx.io/api-reference/payments/create.md): Create an invoice and generate a deposit address in a single call
- [Get Settlement](https://docs.settlx.io/api-reference/settlements/get.md): Retrieve a single settlement by ID
- [Get Invoice Settlement](https://docs.settlx.io/api-reference/settlements/invoice.md): Retrieve the settlement for a specific invoice
- [List Settlements](https://docs.settlx.io/api-reference/settlements/list.md): Retrieve a paginated list of settlements for your merchant account
- [Enroll Subscriber](https://docs.settlx.io/api-reference/subscriptions/enroll.md): Enroll a customer into a subscription plan
- [List Tokens](https://docs.settlx.io/api-reference/tokens.md): Retrieve all supported tokens in a token-first format
- [Test Webhook](https://docs.settlx.io/api-reference/webhooks/test.md): Send a test webhook to verify your endpoint is working
- [Authentication](https://docs.settlx.io/authentication.md): Authenticate API requests using your secret API key
- [Direct Integration](https://docs.settlx.io/guides/direct-integration.md): Build a fully custom checkout UI using the Settlx API
- [Expired Invoices](https://docs.settlx.io/guides/expired-invoices.md): Handle invoice expiry and give customers a second chance to pay
- [Hosted Checkout](https://docs.settlx.io/guides/hosted-checkout.md): Accept crypto payments using the Settlx hosted checkout page
- [Partial Payments](https://docs.settlx.io/guides/partial-payments.md): Handle underpayments and multi-transaction payments
- [Subscriptions](https://docs.settlx.io/guides/subscriptions.md): Collect recurring crypto payments with plans, subscribers, and automatic billing cycles
- [Testing](https://docs.settlx.io/guides/testing.md): Verify your integration before going live
- [Introduction](https://docs.settlx.io/introduction.md): Crypto payment infrastructure for online merchants
- [invoice.confirmed](https://docs.settlx.io/webhook-events/invoice-confirmed.md): Payment confirmed on-chain and the invoice is ready for settlement.
- [invoice.expired](https://docs.settlx.io/webhook-events/invoice-expired.md): Fired when an invoice's expiry time is reached without full payment.
- [invoice.failed](https://docs.settlx.io/webhook-events/invoice-failed.md): An invoice failed in a non-recoverable way. Currently fires for wrong-token resolutions.
- [invoice.settled](https://docs.settlx.io/webhook-events/invoice-settled.md): Funds have been transferred to your wallet. This is the event to act on — it is the only event that guarantees funds are in your wallet.
- [invoice.underpaid](https://docs.settlx.io/webhook-events/invoice-underpaid.md): A payment was received but the amount is less than the invoice total.
- [subscriber.activated](https://docs.settlx.io/webhook-events/subscriber-activated.md): The subscriber's first payment has been confirmed on-chain. Their subscription is now active. Provision access now.
- [subscriber.cancelled](https://docs.settlx.io/webhook-events/subscriber-cancelled.md): The subscription has been cancelled by the merchant. No further invoices will be created.
- [subscriber.enrolled](https://docs.settlx.io/webhook-events/subscriber-enrolled.md): A customer has been enrolled into a subscription plan. The first invoice has been created and is awaiting payment.
- [subscriber.expired](https://docs.settlx.io/webhook-events/subscriber-expired.md): The grace period has elapsed without payment. The subscription has ended. Revoke access now.
- [subscriber.past_due](https://docs.settlx.io/webhook-events/subscriber-past-due.md): A new billing cycle has started and a renewal invoice has been created. Payment has not yet been received.
- [subscriber.paused](https://docs.settlx.io/webhook-events/subscriber-paused.md): The subscription has been paused by the merchant. Billing is suspended and no new invoices will be created until resumed.
- [subscriber.resumed](https://docs.settlx.io/webhook-events/subscriber-resumed.md): A paused subscription has been resumed by the merchant. Billing will restart on the next cycle. Restore access now.
- [Integration](https://docs.settlx.io/webhooks/integration.md): How to receive, verify, and handle Settlx webhook events
- [Overview](https://docs.settlx.io/webhooks/overview.md): Real-time notifications for invoice, payment, and subscription lifecycle events

## OpenAPI Specs

- [openapi](https://docs.settlx.io/api-reference/openapi.json)