AREA SVILUPPATORI · API & WEBHOOK

Integra Inprimepay. Nel tuo flusso.

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.

✓ Piano API 0€ ✓ Hosted Checkout + OpenAPI ✓ Webhook firmati
LOW-CODE URL + query string Checkout precompilato.
WEBHOOK 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=Fattura%20%23001"
+ "&type=installments"
+ "&callback_url=https%3A%2F%2Fmerchant-site.com%2Fcallback";

window.location.href = checkout;
Una documentazione pensata per andare online velocemente. La logica base utilizza Hosted Checkout e webhook: il pagamento resta nell’ambiente Inprimepay, il tuo sistema riceve l’esito.
0€ PIANO API
3 TIPI DI FLUSSO
POST WEBHOOK
Inprimepay Hosted Checkout
Query String Low-Code
OpenAPI Server-to-server
Webhook POST asincrono
HMAC-SHA256 Firma webhook
ARCHITETTURA

Il tuo software controlla il flusso. Inprimepay gestisce il 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.

  • URL base: https://app.inprimepay.com/#/cpl/{MERCHANT_ID}.
  • Importo e nome cliente possono essere precompilati e resi non modificabili.
  • 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.
Vedi i parametri →
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
Importo del pagamento, ad esempio 100.50. Se specificato, il relativo campo viene precompilato e disabilitato.
name
string
Nome o ragione sociale del cliente, ad esempio Cliente%20S.p.A.. Se specificato, il campo viene precompilato e disabilitato.
description
string
Causale del pagamento, ad esempio Fattura%20%23A12. Precompila la causale, che resta modificabile dall’utente.
type
enum
Tipo di pagamento da pre-selezionare: pay_now, installments oppure 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

Il pagamento termina. Il tuo sistema lo sa.

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

Evento Il payload della guida utilizza payment.succeeded.
Identificativi Include eventId, chargeId, sessionId, customerId e orderId.
Dati transazione Importo, valuta, stato, merchant, timestamp originale e metodo di pagamento.
Parametri custom I riferimenti inclusi nel callback_url, come 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 firmato.

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

Header X-InPrimePay-Signature
Algoritmo HMAC-SHA256 in formato esadecimale / hex.
Contenuto da firmare Il raw JSON request body ricevuto.
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.

✓ Massima Sicurezza Compliance PCI-DSS di livello 1.
✓ Metodi Multipli Carte, Klarna, Satispay.
✓ Velocità Integrazione completabile in pochi minuti.
✓ Affidabilità Uptime del 99,9% garantito.
DOVE USARLE

Non solo ecommerce.

Il flusso Hosted Checkout + webhook può essere utilizzato in diversi touchpoint digitali e retail senza cambiare la logica di integrazione.

</>

Software gestionali

Genera un checkout direttamente da ERP, CRM o software verticale e registra l’esito nel tuo flusso tramite webhook.

▣

App e SaaS

Collega il pagamento a un processo applicativo mantenendo l’interfaccia di checkout nell’ambiente Inprimepay.

W

Ecommerce custom

Porta Pay Now, rate e subscription in un checkout proprietario senza dover costruire la pagina di pagamento.

▥

Kiosk e self-service

Genera il pagamento da totem, schermi touch e altri flussi fisici collegati a sistemi software.

QR

Retail assistito

Crea un checkout con importo e causale già impostati e porta il cliente al pagamento da un touchpoint di negozio.

↻

Pagamenti ricorrenti

Utilizza il tipo subscription nei flussi in cui la configurazione del merchant e del provider supporta pagamenti ricorrenti.

5 · REQUISITI PER L’AVVIO
Serve davvero poco.
1
Merchant ID Inprimepay È il riferimento utilizzato nell’URL base del Checkout Hosted.
2
URL del Webhook Ad esempio 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
Account e metodi abilitati I metodi effettivamente disponibili dipendono dai servizi e provider attivati sul merchant.
Nota informativa: 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
FAQ SVILUPPATORI

Prima di passare il link al dev.

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

Il Piano API ha un costo fisso?

Il Piano API Inprimepay è proposto a 0€ come accesso alla soluzione. Restano applicabili le commissioni dei servizi e dei provider di pagamento utilizzati.

Devo integrare un checkout da zero?

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}.

Posso passare importo e nome cliente?

Sì. I parametri amount e name possono essere passati via query string e, se presenti, vengono precompilati e resi non modificabili.

Quali tipi di pagamento posso pre-selezionare?

La documentazione prevede pay_now, installments e subscription. La disponibilità concreta dei relativi metodi dipende dai servizi attivati sul 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.

Come ricevo la conferma della transazione?

Passando un 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.

Posso integrare Inprimepay in un gestionale o kiosk?

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

Passa questa pagina al tuo sviluppatore.

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.

Attiva Piano API 0€ →