canonical: https://jentic.com/apis/nomod.com/nomod

# Nomod API

Jentic publishes the only available OpenAPI specification for Nomod API, keeping it validated and agent-ready. Nomod is a mobile-first payment platform that lets small merchants accept card payments without a terminal, generating payment links, hosted checkout pages, and invoices for one-off and recurring billing. The API exposes payment links, invoices, charges, hosted checkout creation, customer records, and team membership management. Independent contractors and small merchants in MENA and emerging markets use it to bill clients without building a full storefront.

## For AI agents

Create payment links, hosted checkout sessions, and invoices, and read charges and customer records on Nomod for small-merchant billing.

## Scope

Does not handle subscriptions, in-person card terminals, or marketplace split payments - use for hosted payment links, checkout, and small-merchant billing only.

## Capabilities

- Create, update, and delete payment links that customers can pay through a hosted page
- List and retrieve invoices issued to customers
- Pull a list of historical charges and inspect a single charge by ID
- Spin up a hosted checkout session that handles card collection on Nomod's domain
- List customer records and retrieve a specific customer's profile
- Manage team members on the merchant account
- Look up supported countries for billing address validation

## Use cases

### Freelancer text-to-pay billing

Independent consultants billing one-off project fees can use Nomod payment links instead of issuing PDF invoices and waiting for bank transfer. POST /links creates a link tied to an amount and currency that the freelancer texts or emails to the client; the client pays through Nomod's hosted page and the freelancer sees the resulting charge via /charges. This compresses days of bank-transfer follow-up into a single message.

Example prompt: Call POST /links with amount=250, currency=USD, and description='Discovery workshop' and return the link URL

### Hosted checkout for a small store

Boutique merchants without a full e-commerce platform can drop a Nomod hosted checkout into a Linktree or social bio. POST /checkout returns a checkout URL that handles card capture, 3D Secure, and receipt delivery on Nomod's domain. The merchant reads the resulting /charges to reconcile sales without managing PCI scope themselves.

Example prompt: Call POST /checkout with amount=49.99 and currency=USD, then return the hosted checkout URL

### Invoice tracking and reconciliation

Small merchants tracking which invoices have been paid pull /invoices to list outstanding bills and /charges to match payments back to invoices. An agent can run this nightly, flag invoices with no matching charge after 14 days, and trigger a follow-up message to the customer.

Example prompt: List invoices with status='unpaid' issued more than 14 days ago and return the customer IDs for follow-up

### AI agent for billing on demand

An AI assistant for a freelancer can react to a 'send so-and-so a bill for the design work' request by creating a Nomod payment link via Jentic, then pasting the URL into a draft message. The agent searches Jentic for 'create a payment link', loads POST /links, and executes - no code, no docs reading.

Example prompt: Through Jentic, search 'create a payment link', load POST /links, and execute with the client's amount and a description

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/links` | Create a payment link |
| GET | `/links` | List payment links |
| PUT | `/links/{id}` | Update a payment link |
| POST | `/checkout` | Create a hosted checkout session |
| GET | `/invoices` | List invoices |
| GET | `/charges` | List historical charges |
| GET | `/customers` | List customers |
| GET | `/countries` | List supported countries |

## Key resources

- **Links** — Create, update, and delete hosted payment links
- **Invoices** — List and retrieve issued invoices
- **Charges** — List and inspect completed charges
- **Checkout** — Create hosted checkout sessions
- **Customers** — List and retrieve customer profiles
- **Team** — List team members on the merchant account
- **Lookup Data** — Reference data such as supported countries

## Why Jentic

- **Setup:** Wiring Nomod by hand means setting up its API key in the Authorization header against nomod.com/v1 and handling every payment link and checkout call yourself. Through Jentic you install once, import the Nomod API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Nomod puts the payment link id in the URL path (`/links/{id}`), so a rule can pin your agent to reads and updates on one link. You choose the operations it may call, so creating a new checkout is not included unless you add it.
- **Credential handling:** Your Nomod API key is stored once, encrypted, by your own Jentic One instance and injected at execution time as the Authorization header. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a payment link' or 'check a charge', and Jentic returns the matching Nomod operation with its input schema so the agent posts to /links without browsing the reference docs.

## Related APIs

- **Stripe API** — Stripe offers a more comprehensive payments platform with global coverage and richer APIs.
- **PayMongo API** — PayMongo focuses on Southeast Asian merchants with similar payment-link tooling.
- **PayPal Payments API** — PayPal offers global brand recognition and payment-link equivalents through invoicing.
- **Square API** — Square covers in-person payments plus online checkout for small merchants.

## FAQ

### Why is there no official OpenAPI spec for Nomod API?

Nomod does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Nomod API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Nomod API use?

Nomod uses an API key passed in the Authorization header. Generate the key in the Nomod merchant dashboard and pass it on every request. Through Jentic, the key is stored in the encrypted vault and never enters the agent's prompt context.

### Can I create a payment link programmatically with the Nomod API?

Yes. POST /links accepts an amount, currency, and description, and returns a hosted link URL you can share with the customer. Use PUT `/links/{id}` to update the link or DELETE `/links/{id}` to revoke it.

### What are the rate limits for the Nomod API?

Nomod's spec does not encode hard rate limits. Treat the API as a per-merchant key bound by reasonable throughput; cache /customers and /countries responses and avoid polling /charges more than once per minute per merchant.

### How do I create a hosted checkout through Jentic?

Install with pip install jentic, then search 'create a hosted checkout', load POST /checkout, and execute with amount and currency. The response includes the URL to redirect the buyer to, and the resulting charge will appear under /charges once paid.

### Does the Nomod API support refunds?

The OpenAPI spec exposes read access to /charges but does not include a dedicated refund endpoint. Issue refunds from the Nomod merchant dashboard, or contact Nomod support to confirm whether a refund endpoint is available on your account tier.

### Can I limit what my agent is allowed to do with the Nomod API?

Yes. Jentic One runs self-hosted on your own infrastructure, so your rules decide which Nomod operations and credentials the agent may use. Because Nomod puts the payment link id in the URL path at `/links/{id}`, you can pin the agent to reading and updating a single link while blocking POST /links, POST /checkout, or /customers reads it does not need. Only the operations you explicitly allow are callable, and your API key is injected at execution time rather than exposed to the agent.