Alma Payments API

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

★ Only Publicly Available SpecPaymentsBilling SubscriptionsapiKey22 EndpointsREST

For Agents

Run the full Alma BNPL flow — check eligibility, create payments, capture deferred payments, issue refunds, and manage orders, customers, addresses, and webhooks.

Quickstart

Get started with Alma Payments API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create an Alma BNPL payment"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Alma Payments API API.

Verify whether a basket is eligible for Alma BNPL options before checkout

Create a new Alma payment for a chosen instalment plan

Capture a deferred payment once goods are shipped

Cancel or update a payment that has not yet captured

Issue a refund against a captured payment

GET STARTED

Start building with Alma Payments API API

Explore with Jentic

View OpenAPI Spec

Use for: I need to check whether a 1200 EUR basket is eligible for 4x payment, Create an Alma payment for a checkout in 3 instalments, Capture a deferred payment now that the order has shipped, Issue a refund for a previous Alma payment

Not supported: Does not handle card payments outside BNPL, KYC document collection, or merchant onboarding — use for Alma BNPL eligibility, payment creation, capture, refunds, and order events only.

Jentic publishes the only available OpenAPI specification for Alma Payments API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Alma Payments API, keeping it validated and agent-ready. Alma is a European buy-now-pay-later (BNPL) provider, and the API covers eligibility checks, payment creation, capture of deferred payments, refunds, customer records, addresses, balance transactions, data exports, and webhook configuration. The endpoint surface is comprehensive enough to run the full BNPL flow from cart eligibility through to post-purchase order updates and shipment notifications.

Use Cases

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

★ Checkout eligibility and payment creation

E-commerce checkouts call POST /eligibility/purchases with the basket value to find which Alma plans (e.g. 3x, 4x, deferred) are available, then call POST /payments to create the chosen plan. This two-step flow is the standard Alma checkout pattern and keeps unsupported plans off the buyer's screen.

Call POST /eligibility/purchases with amount 120000 (cents) and the customer's country, then call POST /payments with the chosen plan and return the redirect URL.

Deferred payment capture on shipment

Merchants using Alma's deferred plan create the payment at checkout but only capture funds when the order ships. The agent listens for the warehouse fulfilment event and calls POST /payments/{id}/capture, then notifies the order status via POST /payments/{payment_id}/orders/shipment. This binds capture to the actual physical fulfilment moment.

When the warehouse webhook fires for shipment of order 5512, call POST /payments/pay_xxx/capture, then POST /payments/pay_xxx/orders/shipment with the tracking number.

Refund and payment lifecycle management

Customer service agents issue refunds via POST /refunds bound to the original payment, cancel pending payments via PUT /payments/{id}/cancel, and modify open payments via POST /payments/{id}/update. The full lifecycle is exposed, so the agent loop covers exceptions without falling back to support email.

Issue a partial refund of 2500 cents on payment pay_xxx via POST /refunds with the amount and a reason note.

Reconciliation via balance transactions and exports

Finance teams pull GET /balance-transactions to reconcile Alma settlements against bank deposits and create scheduled data exports via POST /data-exports for accounting downloads. Webhook configuration via POST /webhooks delivers payment lifecycle events to the merchant's reconciliation pipeline so reports stay current without polling.

Call GET /balance-transactions filtered to last week, then trigger POST /data-exports for the same range and notify accounting when ready.

AI agent BNPL orchestration

An AI agent embedded in a checkout assistant can call eligibility, create a payment, send the payment link, and write back order updates as the customer progresses. Through Jentic the agent searches by intent for each step, and the Alma API key is held in the vault — the buyer's checkout flow never exposes the secret.

Use Jentic to search 'create an Alma payment', execute POST /payments with the chosen plan, and call POST /payments/{id}/email to send the payment link to the buyer.

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

/eligibility/purchases

Check eligibility for Alma plans

POST

/payments

Create a new payment

POST

/payments/{id}/capture

Capture a deferred payment

POST

/refunds

Issue a refund

POST

/payments/{id}/email

Send a payment link via email

GET

/balance-transactions

Read balance transactions for reconciliation

POST

/webhooks

Configure webhooks for events

POST

/eligibility/purchases

Check eligibility for Alma plans

POST

/payments

Create a new payment

POST

/payments/{id}/capture

Capture a deferred payment

POST

/refunds

Issue a refund

POST

/payments/{id}/email

Send a payment link via email

Why though Jentic?

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

Credential isolation

Alma API keys are stored encrypted in the Jentic vault and injected into the Authorization header at execution time. Agents call operations by intent and the raw key never enters the prompt context.

Intent-based discovery

Agents search 'check Alma BNPL eligibility' or 'create an Alma payment' and Jentic returns the matching operation with its input schema, so the agent calls the right endpoint without parsing docs.

Time to first call

Direct Alma integration: 2-4 days for auth wiring, eligibility flow, capture lifecycle, and webhook handling. Through Jentic: under 1 hour — search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Afterpay

Afterpay offers a similar BNPL flow with global merchant coverage

Choose Afterpay when the merchant operates in regions where Alma is not available

Alternative

Affirm

Affirm offers BNPL with longer-term instalment plans, US-focused

Choose Affirm for US shoppers and longer 12-36 month instalment plans

Complementary

Stripe

Stripe handles card and wallet payments alongside Alma BNPL

Use Stripe for card and wallet checkout while Alma handles BNPL on the same store

Complementary

Mollie

Mollie aggregates European payment methods that pair well with Alma

Use Mollie when the merchant needs iDEAL, Bancontact, or SEPA alongside Alma BNPL

FAQs

Specific to using Alma Payments API 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?

An API key passed in the Authorization header (apiKey scheme). Through Jentic, the key is stored in the encrypted vault and injected at execution time so it never appears in agent prompts or logs.

Can I check BNPL eligibility before showing instalment options?

Yes. POST /eligibility/purchases takes the basket amount and customer country and returns the eligible Alma plans. This lets the checkout only render plans the buyer actually qualifies for.

How do I issue an Alma refund through Jentic?

Run pip install jentic, search 'issue an Alma refund', load the input schema for POST /refunds, and execute with the original payment ID and the refund amount in cents. Partial refunds are supported.

Does the Alma Payments API support deferred capture?

Yes. Create the payment with a deferred plan and call POST /payments/{id}/capture when goods ship. Pair this with POST /payments/{payment_id}/orders/shipment to report tracking information at the same time.

Can I configure webhooks for payment events?

Yes. POST /webhooks registers an endpoint that receives payment lifecycle events. This removes the need to poll for status changes and supports event-driven reconciliation.