DEVELOPER AREA · API & WEBHOOK

Integrate Inprimepay. In your flow.

Integra “Pay with Inprimepay” tramite Hosted Checkout, query string, generazione Custom Payment Link server-to-server e webhook POST. Puoi precompilare il checkout, generare un token in tempo reale e validare le notifiche con firma HMAC-SHA256.

✓ API Plan €0 ✓ Hosted Checkout + OpenAPI ✓ Webhook firmati
LOW-CODE URL + query string Pre-filled checkout.
WEB HOOK payment.succeeded POST + firma HMAC.
checkout.js
Hosted Checkout URL
const checkout =
"https://app.inprimepay.com/#/cpl/{MERCHANT_ID}"
+ "?amount=150.00"
+ "&name=Cliente%20S.p.A."
+ "&description=Invoice%20%23001"
+ "&type=installments"
+ "&callback_url=https%3A%2F%2Fmerchant-site.com%2Fcallback"; window.location.href = checkout;
Documentation designed to go online quickly. The basic logic uses Hosted Checkout and webhooks: the payment remains in the Inprimepay environment, your system receives the outcome.
€0 API PLAN
3 FLOW TYPES
POST WEB HOOK
Inprimepay Hosted Checkout
Query String Low-code
OpenAPI Server-to-server
webhook POST asincrono
HMAC-SHA256 Firma webhook
ARCHITECTURE

Your software controls the flow. Inprimepay handles the checkout.

La documentazione prevede due modalità complementari: un’integrazione Low-Code basata su URL Hosted Checkout e una generazione dinamica server-to-server tramite OpenAPI.

  • Base URL: https://app.inprimepay.com/#/cpl/{MERCHANT_ID}.
  • The amount and customer name can be pre-filled and made uneditable.
  • La causale può essere precompilata e resta modificabile dall’utente.
  • Puoi pre-selezionare pay_now, installments o subscription.
  • Il callback_url può includere parametri custom come order_id o reference.
  • I parametri custom del callback vengono restituiti nel payload webhook.
  • Per i link dinamici puoi utilizzare l’endpoint OpenAPI con autenticazione X-Api-Key.
  • Le notifiche webhook possono essere validate con X-InPrimePay-Signature.
See parameters →
QUICK START

Dal tuo ordine all’esito in tre passaggi.

Configura il Checkout Hosted, genera se necessario un Custom Payment Link dal tuo server e ricevi la notifica asincrona della transazione.

01 · LINK

Configura l’Hosted Checkout.

Parti dall’URL del Merchant ID e aggiungi i parametri query necessari.

https://app.inprimepay.com/
#/cpl/{MERCHANT_ID}

?amount=150.00
&name=Cliente%20S.p.A.
&type=installments
02 · OPENAPI

Genera il link dal server.

Invia una POST all’endpoint OpenAPI usando il tuo Webhook Secret nell’header X-Api-Key.

POST /api/custom-payment-links/
openapi/generate

X-Api-Key: {WEBHOOK_SECRET}
Content-Type: application/json
03 · WEBHOOK

Ricevi e valida l’esito.

Al completamento del pagamento ricevi un POST con evento payment.succeeded e firma HMAC-SHA256.

event: payment.succeeded
header:
X-InPrimePay-Signature
1 · CONFIGURAZIONE LINK

Precompila il Checkout Hosted via query string.

Reindirizza il cliente alla URL di pagamento sicura e passa i dati tramite query string per un’integrazione Low-Code rapida.

URL Base https://app.inprimepay.com/#/cpl/{MERCHANT_ID}
amount
decimal
Payment amount, for example 100.50If specified, the relevant field is pre-filled and disabled.
name
string
Customer's name or company name, for example Cliente%20S.p.A.If specified, the field is pre-populated and disabled.
description
string
Reason for payment, for example Fattura%20%23A12Pre-fill the reason, which can still be modified by the user.
type
enum
Payment type to pre-select: pay_now, installments or subscription.
callback_url
URL encoded
URL per la notifica webhook POST. Deve essere URL-encoded. Può includere parametri custom come ?order_id=12345 o reference: vengono estratti automaticamente e restituiti nel payload del webhook.
Esempio di link completo Hosted Checkout
https://app.inprimepay.com/#/cpl/{MERCHANT_ID}?amount=150.00&name=Cliente%20S.p.A.&description=Fattura%20%23001&type=installments&callback_url=https%3A%2F%2Fmerchant-site.com%2Fcallback
2 · CUSTOM PAYMENT LINK

Genera il link dinamicamente dal tuo server.

Per ogni nuovo ordine puoi utilizzare l’endpoint OpenAPI. L’autenticazione avviene tramite il tuo Webhook Secret, reperibile nel Profilo della piattaforma.

Endpoint OpenAPI POST https://api.inprimepay.com/api/custom-payment-links/openapi/generate
X-Api-Key Header richiesto. Valore: il tuo Webhook Secret.
Content-Type application/json
amount Obbligatorio. Importo numerico decimale, ad esempio 99.00.
clientName Obbligatorio. Nome o identificativo testuale del cliente.
Description Opzionale. Causale del pagamento.
POST /api/custom-payment-links/openapi/generate REQUEST
X-Api-Key: {WEBHOOK_SECRET}
Content-Type: application / json

{
  "amount": 99.00,
  "clientName": "Cliente S.p.A.",
  "description": "Acquisto Servizio Premium"
}
Risposta attesa Token univoco
{
  "token":
  "d7a8e2b1-4f4c-11eb-ae93-0242ac130002"
}
URL finale per il cliente Token + callback_url
https://app.inprimepay.com/#/cpl/{MERCHANT_ID}?token=d7a8e2b1-4f4c-...&callback_url=https%3A%2F%2Fmerchant-site.com%2Fcallback%3Forder_id%3D12345
3 · NOTIFICA PAGAMENTO

Payment is complete. Your system knows it.

Al completamento della transazione, il server Inprimepay invia una notifica POST asincrona all’endpoint specificato nel callback.

Event Il payload della guida utilizza payment.succeeded.
Identifiers Include eventId, chargeId, sessionId, customerId e orderId.
Transaction data Importo, valuta, stato, merchant, timestamp originale e metodo di pagamento.
Parametri custom I riferimenti inclusi nel callback_url, as order_id, possono essere restituiti nel payload.
Sicurezza e firma webhook →
POST /callback payment.succeeded
{
  "event": "payment.succeeded",
  "eventId": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
  "timestamp": 1696772400,
  "chargeId": 14592,
  "sessionId": "cs_test_a1b2c3d4...",
  "customerId": "{MERCHANT_ID}",
  "orderId": "12345",
  "amount": 100.50,
  "currency": "eur",
  "status": "Success",
  "merchant": "InPrime Pay",
  "originalTimestamp": "2024-05-13T10:35:42Z",
  "paymentMethod": "card"
}
SICUREZZA E VALIDAZIONE
webhook signed.

Per verificare che la notifica POST provenga legittimamente dai server Inprimepay, la richiesta include una firma di validazione.

Header X-InPrimePay-Signature
Algorithm HMAC-SHA256 in formato esadecimale / hex.
Contenuto da firmare Il raw JSON request body received.
Chiave crittografica Il tuo Webhook Secret.
Verifica Calcola l’HMAC-SHA256 del raw JSON con il Webhook Secret. Se l’hash generato coincide con il valore dell’header, la notifica è autentica.
chargeId L’identificativo chargeId è indicato nella guida come univoco e stabile.
4 · PUNTI DI FORZA

I punti evidenziati nella Partner Technical Guide.

La guida tecnica allegata riporta sicurezza, metodi disponibili, velocità di integrazione e affidabilità dell’infrastruttura.

✓ Maximum Security PCI-DSS Level 1 Compliance.
✓ Metodi Multipli Cards, Klarna, Satispay.
✓ Swift Integration can be completed in minutes.
✓ Proven Reliability 99,9% uptime guaranteed.
WHERE TO USE THEM

Not just e-commerce.

The Hosted Checkout + webhook flow can be used across multiple digital and retail touchpoints without changing the integration logic.

Management software

Generate a checkout directly from ERP, CRM, or vertical software and record the outcome in your flow via webhook.

▣

Apps and SaaS

Connect payment to an application process while keeping the checkout interface in the Inprimepay environment.

W

Custom e-commerce

Bring Pay Now, installments, and subscriptions into a proprietary checkout without having to build the payment page.

▥

Kiosk and self-service

Generate payments from kiosks, touch screens, and other physical flows connected to software systems.

QR

Assisted retail

Create a checkout with the amount and reason already set and take the customer to payment from a store touchpoint.

↻

Recurring payments

Use the type subscription in flows where the merchant and provider configuration supports recurring payments.

5 · REQUISITI PER L’AVVIO
It really helps bit.
1
Inprimepay Merchant ID È il riferimento utilizzato nell’URL base del Checkout Hosted.
2
Webhook URL For example https://api.vostrosito.it/callback/payments.
3
Webhook Secret Reperibile nel Profilo della piattaforma. Viene utilizzato per X-Api-Key e per la validazione HMAC della firma webhook.
4
Enabled accounts and methods The methods actually available depend on the services and providers activated on the merchant.
Informative note: il documento tecnico allegato è indicato come bozza tecnica preliminare ad uso interno e per finalità di discussione. Specifiche, nomi dei parametri e struttura del payload potrebbero subire variazioni in fase di implementazione definitiva.
Supporto tecnico Inprimepay Riferimento indicato nella Partner Technical Guide.
assistenza@inprimepay.com
DEVELOPER FAQ

Before passing the link to the dev.

Le risposte essenziali sull’integrazione, incluse le specifiche aggiunte dalla Partner Technical Guide.

Does the API Plan have a fixed cost?

The Inprimepay API Plan is offered at €0 for access to the solution. Fees for the services and payment providers used still apply.

Do I need to integrate a checkout from scratch?

No. L’integrazione utilizza un Hosted Checkout Inprimepay: il tuo sistema costruisce il link e reindirizza il cliente all’URL di pagamento.

Qual è l’URL base corretto del Checkout Hosted?

https://app.inprimepay.com/#/cpl/{MERCHANT_ID}.

Can I enter the amount and customer name?

Yes. The parameters amount e name possono essere passati via query string e, se presenti, vengono precompilati e resi non modificabili.

What payment types can I pre-select?

La documentazione prevede pay_now, installments e subscriptionThe actual availability of the relevant methods depends on the services activated by the merchant.

Il callback_url può contenere order_id o reference?

Sì. La guida specifica che callback_url può includere parametri custom come order_id o reference; vengono estratti automaticamente e restituiti nel payload webhook.

Come genero un Custom Payment Link dal mio server?

Effettua una POST a https://api.inprimepay.com/api/custom-payment-links/openapi/generate usando il Webhook Secret nell’header X-Api-Key e Content-Type: application/json.

Quali campi richiede la generazione server-to-server?

amount e clientName sono indicati come obbligatori; description è opzionale. La risposta restituisce un token univoco.

How do I receive transaction confirmation?

Passing a callback_url codificato, il server Inprimepay invia al completamento della transazione una notifica webhook POST asincrona. L’evento indicato nella guida è payment.succeeded.

Come verifico che il webhook sia autentico?

Calcola l’HMAC-SHA256 del raw JSON request body utilizzando il tuo Webhook Secret e confronta il risultato hex con l’header X-InPrimePay-Signature.

Il chargeId è un riferimento stabile?

Sì. La Partner Technical Guide indica che chargeId è univoco e stabile.

Can I integrate Inprimepay into a management system or kiosk?

Sì. Il modello Hosted Checkout + webhook è adatto anche a gestionali, applicazioni, piattaforme, ecommerce custom e flussi retail.

Please pass this page on to your developer.

Hai a disposizione Hosted Checkout, parametri query, generazione server-to-server, token, webhook POST e validazione HMAC-SHA256. Per il supporto tecnico: assistenza@inprimepay.com.

Activate API Plan €0 →