When to use Checkout Session
- You want a fast, secure way to accept payments with minimal UI work
- You need a hosted page that supports multiple payment methods out-of-the-box
- You want Monime to handle payment state, redirection, and receipt UI
How it works
1
Create a Checkout Session (server)
Your server calls the API to create a session with amount, currency, and options.
2
Redirect customer
Redirect the customer to the hosted checkout URL returned in the session.
3
Customer pays
The customer completes payment on Monime’s secure page.
4
Webhook + Return URL
Receive payment status via webhook and/or redirect back to your site.
Quick start
Create Session API
Create a new checkout session from your backend
Retrieve Session
Look up a session to check its latest status
List Sessions
Browse sessions for reporting or debugging
Key session fields
amount
amount
Total amount to be collected. Define in the smallest currency unit when applicable.
currency
currency
The currency for the payment (e.g., SLE). Must be supported by selected methods.
payment_methods
payment_methods
Allowed payment methods for the checkout (e.g., mobile money, bank, card).
success_url / cancel_url
success_url / cancel_url
Where customers are redirected after a successful payment or when they cancel.
metadata
metadata
Optional key/value pairs you can use to store order identifiers or context.
Webhooks
We recommend handling payment lifecycle events using webhooks to ensure your system is updated even if the customer closes the browser before redirecting.Webhook Overview
Learn how webhooks work on Monime
HMAC Verification
Verify webhook signatures securely
Environments: Test vs Live
Use Test mode for development and Live for production. Tokens, behavior, and prefixes differ between environments.See API Basics → Environments and
Standard Headers for details.