API Reference

Every public Havala endpoint with its path, parameters, headers, signature pattern and a real response body. Two surfaces: the signed merchant gateway your server calls, and the unauthenticated checkout API behind the buyer's payment page. Account management lives in the merchant dashboard and has no public API.

CoreRecommendedOptional

Core endpoints are the minimum for taking a payment end to end: create an invoice, check it out onto a chain, then read the payment through to COMPLETED. Recommended endpoints cover operations you will want before launch. The rest are situational.

Invoices5 endpoints

The core of a Havala integration. Create a fiat-denominated invoice, check it out onto a chain and token, and follow it through to PAID. Signed with your merchant point credentials.

POST/api/v1/invoicesCoreCreate Invoice GET/api/v1/invoices/{id}CoreGet Invoice GET/api/v1/invoices/{id}/statusCoreGet Invoice Status POST/api/v1/invoices/{id}/checkoutCoreCheckout Invoice DELETE/api/v1/invoices/{id}RecommendedCancel Invoice

Payments3 endpoints

The on-chain half of an invoice: the leased deposit address, the amount actually received, confirmation progress and the transaction hash. Filterable by status and blockchain.

GET/api/v1/paymentsRecommendedList Payments GET/api/v1/payments/{id}CoreGet Payment GET/api/v1/payments/{id}/statusCoreGet Payment Status

Checkout5 endpoints

The unauthenticated API behind the hosted payment page. Read an invoice as the buyer sees it, pick a chain and currency, and poll the payment that comes back. Possession of the invoice id is the capability — nothing is signed.

GET/checkout/api/v1/invoices/{id}RecommendedGet Public Invoice GET/checkout/api/v1/invoices/{id}/statusRecommendedPoll Invoice Status POST/checkout/api/v1/invoices/{id}/checkoutRecommendedCreate Payment For Invoice GET/checkout/api/v1/payments/{id}/statusRecommendedPoll Payment Status POST/checkout/api/v1/payments/{id}/confirmConfirm Havala Wallet Payment

Coverage Stats

Total Endpoints