Integration Journey Overview
Follow this blueprint to move from your first Supplier Portal login to a production-ready integration. Each phase links directly to the right portal screen or technical guide so your team always knows the next action.
Who is this guide for?
Product managers, solution architects, and engineers responsible for launching ProBuy should use this as the master checklist. Share it with stakeholders to align expectations and timelines.
Developers can dive deeper into specific implementation paths via the SDK and Direct API sections linked below.
Lifecycle at a Glance
ProBuy Integration Lifecycle
Create Your Supplier Account
Register your company in the ProBuy Supplier Portal using your CR number. Complete OTP verification and company profile setup.
- ✅ Finish company details and compliance questions
- ✅ Enable two-factor authentication for admins
- ⏳ Wait for admin approval (see below)
Account Activation Required
After registration, your account will be in "Pending Approval" status. You need approval from ProBuy Admin team before accessing integration features (API tokens & webhooks).
To get approved:
- Option 1: Send an email to [email protected] requesting account activation
- Option 2: ProBuy admin team will review and approve your account within 24-48 hours
Once approved, you'll receive a confirmation email and can proceed to generate API credentials.
Generate API Credentials
⚠️ Prerequisite: Your supplier account must be approved by ProBuy Admin team before you can access this feature.
Head to Integrations → API Tokens inside the portal and create a dedicated token for (sandbox and production) environment. Store tokens securely on your backend—never expose them in client code.
| Environment | API Base URL | Supplier Portal | Company Portal |
|---|---|---|---|
| Sandbox | https://sandboxapi.probuy.dev | https://sandboxsupplier.probuy.dev | https://sandboxcompany.probuy.dev |
| Production | https://api.probuy.me | https://supplier.probuy.me | https://company.probuy.me |
https://sandboxapi.probuy.devhttps://sandboxsupplier.probuy.devhttps://sandboxcompany.probuy.devhttps://api.probuy.mehttps://supplier.probuy.mehttps://company.probuy.meConfigure Webhooks
⚠️ Prerequisite: Your supplier account must be approved by ProBuy Admin team before you can access this feature.
In the portal, open Integrations → Webhooks and register your HTTPS endpoint to receive order lifecycle events. Subscribe at least to order.approved, order.declined, and order.completed to keep your system in sync.
Use your webhook handler to update order status, release inventory, and trigger downstream workflows.
Choose an Integration Path
Select the implementation style that fits your stack. You can mix approaches if you run multiple channels:
- Backend SDK: Streamlined Node.js implementation with helpers for checkout sessions and signature validation.
- Direct REST APIs: Full control for any language or backend using standard HTTPS requests.
Build & Test the Flow
Implement the customer checkout flow, power it with your chosen SDK or APIs, and drive the redirect to ProBuy. Use sandbox credentials and test cards referenced in the Testing section to verify every outcome.
- ☑️ Successful checkout and redirect to success URL
- ☑️ Decline handling with retry options
- ☑️ Webhook reconciliation and order fulfillment
- ☑️ Settlement reporting in the Supplier Portal
Go Live & Monitor
Switch tokens and endpoints to production once the go-live checklist is complete. Enable alerting on webhook failures and API error rates. Keep an eye on settlement reports and dispute notifications through the Supplier Portal.
Decision Matrix
| Path | Best For | Prerequisites | Documentation |
|---|---|---|---|
| Backend SDK (Node.js) | Custom partner platforms or service backends built with Node.js/TypeScript | Server with Node.js 18+, secure env storage | View guide → |
| Direct REST API | Any language/framework that prefers raw HTTP integration | Ability to sign requests, manage webhooks | View guide → |
Testing & Launch
Before you go live
- 🧪 Run through the full sandbox checkout flow end-to-end.
- 🔁 Simulate declines, cancellations, and manual captures.
- 📬 Confirm webhook retries and notification emails.
- 📊 Reconcile transactions in Supplier Portal reports.
When every item checks out, complete the Go-Live Checklist and switch your credentials to production.
Support Channels
Integration Support
Technical questions, SDK guidance, API troubleshooting.