Getalma Alma Payments API

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

★ Only Publicly Available OpenAPI DocumentPaymentsPayment ProcessingapiKey22 EndpointsREST

For Agents

Create and capture buy-now-pay-later payments through Alma, check shopper eligibility, issue refunds, and manage orders and customers for European merchants. Configure webhooks and pull balance transactions for reconciliation.

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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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 a buy-now-pay-later payment with a chosen instalment plan and surface the redirect URL to the shopper

Check whether a basket is eligible for Alma instalments before showing the option at checkout

Capture a deferred payment once goods ship and refund a captured payment when the customer returns it

GET STARTED

Start building with Alma Payments API

Explore with Jentic

View OpenAPI Document

Use Cases

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

★ Checkout BNPL Integration

European e-commerce sites want to offer 2x, 3x, or 4x instalment plans at checkout to lift conversion on baskets above a certain threshold. The Alma API supports running an eligibility check on the basket and then creating a payment with the chosen plan, returning a hosted redirect URL the merchant displays to the shopper. This is the core merchant integration for BNPL.

Run `POST /eligibility/purchases` on the basket, then call `POST /payments` with the selected instalment plan and return the hosted redirect URL to the shopper.

Deferred Payment for Shipped Goods

Merchants selling physical goods often defer the customer charge until the order ships. The Alma API exposes a capture endpoint that finalises a previously authorised payment when fulfilment occurs, so the merchant only collects funds against confirmed shipments. Refunds and partial refunds are also supported on the same payment object.

On shipment confirmation, call `POST /payments/{id}/capture` for the matching payment ID and update the order with the capture timestamp.

Reconciliation and Balance Reporting

Finance teams need to reconcile Alma payouts with internal sales records on a daily basis. The API's balance-transactions and data-exports endpoints provide structured records of every payment, refund, and fee, so an automated job can pull the day's activity and match it to the merchant's ledger.

Call `GET /balance-transactions` for yesterday's date range and write the records to a finance warehouse table for reconciliation.

Agent-Driven Refund Workflow

An AI agent embedded in customer support tooling can resolve a refund request by looking up the Alma payment, calling the refund endpoint through Jentic, and confirming the result back to the agent. The agent never handles the Alma API key directly — Jentic manages the credential and surfaces only the operation contract.

Look up the payment ID for an order, call `POST /refunds` with the amount and reason, and reply to the customer with the refund confirmation.

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 with an instalment plan

POST

/eligibility/purchases

Check basket eligibility for BNPL

POST

/payments/{id}/capture

Capture a deferred payment

POST

/refunds

Create a refund

POST

/payments/{id}/email

Send the payment link by email

GET

/balance-transactions

List balance transactions for reconciliation

POST

/webhooks

Configure a webhook for payment events

POST

/payments

Create a payment with an instalment plan

POST

/eligibility/purchases

Check basket eligibility for BNPL

POST

/payments/{id}/capture

Capture a deferred payment

POST

/refunds

Create a refund

POST

/payments/{id}/email

Send the payment link by email

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Alma API keys are stored encrypted in the Jentic vault. Agents call Alma operations via Jentic and the platform injects the `Authorization` header at runtime, so the raw key never enters the agent's prompt.

Intent-based discovery

Agents search Jentic by intent (e.g. 'create a buy-now-pay-later payment' or 'refund an Alma payment') and Jentic returns the matching Alma operation with its input schema and required fields.

Time to first call

Direct Alma integration: 2-4 days to wire eligibility, payment creation, capture, refunds, and webhook handling. Through Jentic: under an hour for the first call, with each operation reusable across agents.

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 Alma Payments API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Alma Payments API use?

The Alma API uses an API key passed in the `Authorization` header (`AlmaAuth` scheme). Through Jentic, the key is stored encrypted in the vault and injected at execution time so agents never see the raw key.

Can I check eligibility before showing BNPL at checkout?

Yes. Call `POST /eligibility/purchases` with the basket details to determine which Alma plans (e.g. 3x, 4x) are available, then only display eligible plans to the shopper.

How do I refund an Alma payment through Jentic?

Search Jentic for `refund a buy-now-pay-later payment via Alma`, load the schema for `POST /refunds`, and execute with the payment ID and amount. Jentic handles the API key automatically.

Does the Alma API support capturing a deferred payment when the order ships?

Yes. Call `POST /payments/{id}/capture` to finalise a previously authorised payment, typically triggered by your fulfilment system.

Can the Alma API process card payments outside of BNPL?

No. Alma is purchase-financing only — it offers instalment and deferred plans, not standalone card processing. Pair it with a card processor for the non-BNPL portion of your checkout.

Getalma Alma Payments API

Connect the Alma Payments API to your agent

Capabilities

Start building with Alma Payments API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs