Inprimepay is a Tree-Nation partner. For every marketing kit shipped, we plant a tree. Discover our forest.
AREA
developers
Webhook API Documentation
Implement inprimepay in any app, platform, or checkout using the open-source API documentation. Send this page to your developer.
External Gateway: "Pay with InPrimePay"
Quick integration guide via Hosted Checkout & Webhooks.
1
Link configuration
Redirect the end customer to the secure payment URL. Data is passed via query string for fast and secure low-code integration.
Base URL: https://app.inprimepay.com/#/cp1/{MERCHANT_ID}
Query Parameters:
- amount: Amount e.g. 198.50. If specified, the relevant field in the payment interface is pre-filled and disabled (not editable by the user).
- name: Name/Company name of the customer e.g. Mario Rossi. If specified, the relevant field in the interface is pre-filled and disabled (not editable by the user).
- Description: Causal e.g. Invoice #%123. Pre-fill the reason field (editable by the user).
- typePayment type to pre-select: pay_now (Pay Now), installations (Installations), subscription (Subscription).
- callback_url: URL for the Webhook notification (POST). Must be URL-encoded.
Example of Full Link:
https://app.inprimepay.com/#/cp1/24718?amount=150.00&name=Mario%20Rossi&description=Fattura%20%23123&type=installments&callback_url=https%3A%2F%2Fapi.tuo-sito.it%2Fcallback
2
Payment Notification (Webhook)
Upon completion of the transaction, our server sends an asynchronous POST notification to your endpoint.
{ "event": "payment_succeeded", "chargeId": "pj_3Pabc...", "amount": 198.50, "currency": "eur", "status": "success", "merchant": "Mario Rossi", "timestamp": "2024-05-13T10:35:42Z", "paymentMethod": "Visa •••• 4242" }
3
Key features
✓
Maximum Security: PCI-DSS Level 1 Compliance.
✓
Multiple Methods: Cards, Klarna, Satispay.
✓
Speed: Integration can be completed in minutes.
✓
Reliability: 99.9% uptime guaranteed.
4
Requirements for starting
To proceed with activation, the partner will need to provide:
- The Webhook URL e.g. https://api.vostrosito.it/callback/payments
