Install Jentic One Beta

Connect the Alma Payments API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Alma Payments API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Falma_france_api%2Falma" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Falma_france_api%2Falma" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Alma Payments API.

Create installment payments and capture or cancel them across the payment lifecycle

Issue full or partial refunds against a completed payment

Check whether a purchase qualifies for buy-now-pay-later installments before checkout

Send a payment link to a customer by SMS or email

Track order status and shipment updates tied to a payment

GET STARTED

Start building with Alma Payments API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Alma Payments API for, with concrete tasks.

★ Agent-Driven Installment Checkout

An AI commerce agent offers buy-now-pay-later at checkout by creating an Alma payment, then confirming capture once the order ships. Through Jentic the agent searches for the payment-creation operation, loads its input schema, and completes the flow without hand-wiring Alma's auth. Alma pays the merchant upfront while the shopper repays in installments.

Create an Alma payment for a shopper's cart, return the payment link, and capture the payment after the order ships

Installment Eligibility Check

Before showing pay-later options, a merchant checks whether a given cart qualifies for Alma installment plans. The eligibility endpoint returns the available plans and their terms so the storefront can display accurate options. This avoids offering a plan the customer cannot actually use.

Submit a cart total and customer country to the eligibility endpoint and return the available installment plans

Refunds and Reconciliation

A finance workflow issues refunds against completed Alma payments and reconciles settlement against balance transactions. Full and partial refunds are supported, and data exports provide the records a bookkeeping system needs. This keeps merchant ledgers aligned with Alma settlements.

Issue a partial refund for a payment and export the day's balance transactions for reconciliation

Payment Link Delivery

A merchant sends a customer a link to complete an Alma installment payment out of band, by SMS or email. This supports phone orders and invoicing scenarios where the shopper is not at the storefront. The customer opens the link and completes the pay-later flow directly with Alma.

Create a payment and send its link to the customer by SMS, then poll for completion

Key Endpoints

22 endpoints — jentic publishes the only available openapi specification for alma payments api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/payments

Create a payment

GET

/payments/{id}

Get a payment by id

POST

/payments/{id}/capture

Capture a payment

PUT

/payments/{id}/cancel

Cancel a payment

POST

/refunds

Create a refund

POST

/eligibility/purchases

Check installment eligibility

POST

/payments/{id}/sms

Send a payment link by SMS

POST

/payments/{id}/email

Send a payment link by email

POST

/payments

Create a payment

GET

/payments/{id}

Get a payment by id

POST

/payments/{id}/capture

Capture a payment

PUT

/payments/{id}/cancel

Cancel a payment

POST

/refunds

Create a refund

POST

/eligibility/purchases

Check installment eligibility

POST

/payments/{id}/sms

Send a payment link by SMS

POST

/payments/{id}/email

Send a payment link by email

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring Alma by hand means handling its Alma-Auth API key against separate production and sandbox hosts and threading it through the payment, capture, refund, and eligibility calls yourself. Through Jentic you install once, import Alma from the API Directory, store the credential once, and your agent calls it.

Permission scoping

Alma puts the payment id in the URL path (/payments/{id}), so a rule can pin your agent to actions on a given payment and the operations you pick. You choose which operations it may call, so refunds and cancellations are not included unless you add them.

Credential isolation

Your Alma API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create an installment payment' or 'check installment eligibility', and Jentic returns the matching Alma operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Alma Payments API through Jentic.

Why is there no official OpenAPI spec for Alma Payments API?

Alma does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the Alma Payments API via structured tooling. It is validated against the live API and kept up to date. To run it on your own infrastructure, install Jentic One from its GitHub repo.

What authentication does the Alma Payments API use?

The Alma Payments API authenticates with an API key sent in the Authorization header, formatted as an Alma-Auth live or test key, per its OpenAPI spec. Through Jentic, that key is stored encrypted by your own Jentic One instance and injected at execution time, so it never enters the agent's prompt or logs.

Can I check installment eligibility with the Alma Payments API?

Yes. The eligibility endpoint takes a purchase amount and returns the installment plans a customer qualifies for, so a storefront can show accurate pay-later options before checkout. Alma supports several plan shapes, such as splitting a purchase into multiple installments or deferring payment.

What are the rate limits for the Alma Payments API?

The OpenAPI spec does not specify rate limits for the Alma Payments API. Check the Alma developer documentation at https://docs.almapay.com/reference for current limits, and back off when you receive a 429 response.

How do I create an Alma payment through Jentic?

Search Jentic for 'create an installment payment'. Jentic returns Alma's payment-creation operation with its input schema covering the amount, customer, and installment plan, so your agent can call it directly. You can then capture the payment once the order ships and issue refunds against it if needed.

Can I limit what my agent is allowed to do with the Alma Payments API?

Yes. You write a rule that allows only the operations the agent needs, such as creating payments and checking eligibility, so destructive operations like issuing refunds or cancelling a payment stay out of reach unless you add them. Because the payment id travels in the URL path, a rule can also bound the agent to actions on the payments it created. Every call the agent makes is logged.

Is there an Alma Payments API MCP server?

You do not need an MCP server to give your agent the Alma Payments API. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent can create payments, issue refunds, and check eligibility. That also keeps your agent's context free of an extra server's tool definitions.

Alma France Api Alma Payments API

Name: Alma Payments API
Brand: Alma Payments API
Availability: InStock

Agent-ready OpenAPI document · curated by JenticPaymentsPayment ProcessingapiKey22 EndpointsREST

Know of an official OpenAPI document? Contribute it →

For Agents

Create and manage Alma installment payments: capture, cancel, and refund transactions, check purchase eligibility, and send payment links by SMS or email.

Use for: I want to create an installment payment for a customer's order, Check whether a purchase is eligible for Alma installments, Issue a refund for a captured payment, Send a payment link to a customer by email

Not supported: Does not handle card network settlement, chargebacks, or accounting. Use for buy-now-pay-later installment payments only.

Jentic publishes the only available OpenAPI specification for Alma Payments API, keeping it validated and agent-ready. The Alma Payments API creates and manages buy-now-pay-later payments for merchants, letting a customer split a purchase into installments while the merchant is paid upfront. It covers the full payment lifecycle: creating a payment, capturing or cancelling it, issuing refunds, checking installment eligibility, and sending payment links by SMS or email. Orders, customers, addresses, and balance transactions round out the merchant integration surface.

Jentic One on Github View OpenAPI Document

Connect the Alma Payments API to your agent

Capabilities

Start building with Alma Payments API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Alma France Api Alma Payments API