Integration Guides
The integration guides provide practical, step-by-step instructions for tasks you perform when building and maintaining a Nimbbl integration. Each guide focuses on a specific topic and applies across all integration types — Standard Checkout, Custom Checkout, and Plug and Play — unless stated otherwise.
These guides assume you have a basic understanding of Nimbbl's core concepts. If you need to understand how orders, payments, and refunds work before diving into implementation, start with How Nimbbl Works.
Getting Started
- Choosing Your Integration — compare no-code, low-code, and full API integration paths, get your test API keys, and understand what each approach requires
Keeping Your System in Sync
- Webhooks — set up webhook endpoints to receive real-time payment notifications, understand retry logic and idempotency, and see the payload reference for every event
- Validating Payment Response with Signature — verify that payment responses are authentic by generating and comparing HMAC SHA256 signatures
Advanced Payment Flows
- Pre-auth and Capture — enable pre-authorization on a sub-merchant account, handle the
authorizedpayment status, and capture or void transactions via Command Center or the API
Security and Compliance
- Handling PII Data — understand how personal data is masked in API responses and webhooks, and how to access unmasked PII securely when needed
- Encrypting Sensitive Data — RSA-encrypt card details and OTP before sending them to Nimbbl, required for merchants who are not PCI DSS certified
- Using Encrypted Payloads — encrypt and decrypt full API payloads using AES-GCM when enhanced security is required
Going to Production
- Testing and Going Live — use test credentials to verify your integration, simulate payment flows for all payment modes, and prepare for production deployment