Getting Started with ProBuy
Welcome to ProBuy! This guide will walk you through everything you need to know to start accepting installment payments on your platform. Follow these steps to set up your merchant account and obtain the necessary credentials.
Prerequisites
Before you begin integrating ProBuy, make sure you have:
- A registered business in Saudi Arabia, or supported regions
- Valid business registration documents (CR certificate)
- A website to integrate payments
- SSL/HTTPS enabled on your website (required for production)
- Basic knowledge of web development
Step 1: Create Your Supplier Account
The first step is to register as a merchant (supplier) with ProBuy. This gives you access to the Supplier Portal where you can manage orders, generate API tokens, and configure your payment settings.
Account Registration Process
Visit the Supplier Portal
Go to https://supplier.probuy.me (production) or sandbox environment
Click "Register" or "Sign Up"
Create a new merchant account by providing your business information
Complete Business Information
Fill in the registration form with your business details:
- Business name and type
- Commercial Registration Entity number
- Tax identification number (VAT number)
- Contact information (email, phone)
- Business address
Upload Required Documents
Submit the following documents for verification:
- Commercial Registration certificate (CR)
- VAT certificate
- Bank account details (IBAN)
Submit for Approval
Once all information is complete, submit your application. The ProBuy team will review your application within 1-3 business days.
Account Activation
You'll receive an email notification once your account is approved and activated. You can then log in and start the integration process.
Account Approval Time
Account approval typically takes 1-3 business days. During this time, the ProBuy compliance team will verify your business documents and perform KYC checks. You'll receive email updates about your application status.
Step 2: Generate Your API Token
Once your account is approved, you need to generate an API token to authenticate your integration requests.
API Token Generation
Log in to Supplier Portal
Access your account at https://supplier.probuy.me
Navigate to Integrations
Go to Integrations → API Tokens in the left sidebar menu
Create New Token
Click the "Create New Token" or "Generate API Token" button
Copy the Token
Important: The token will be displayed only once. Copy it immediately and store it securely. You won't be able to see it again.
Security Best Practices
- Never expose your API token in client-side code, public repositories, or browser console
- Store tokens securely in environment variables or secure credential stores
- Use different tokens for sandbox and production environments
- Immediately revoke and regenerate tokens if compromised
- For production, implement server-side token handling
Step 3: Configure Return URLs
Return URLs are the pages where customers will be redirected after completing, canceling, or failing the payment process. You need to set these up in your integration.
| URL Type | Purpose | Example |
|---|---|---|
| Success URL | Where customers land after successful payment | https://yourstore.com/payment/success |
| Failure URL | Where customers land if payment fails | https://yourstore.com/payment/failed |
| Cancel URL | Where customers land if they cancel the payment | https://yourstore.com/payment/cancelled |
https://yourstore.com/payment/successhttps://yourstore.com/payment/failedhttps://yourstore.com/payment/cancelledReturn URL Tips
- Use HTTPS URLs (required for production)
- Include order identifiers in URLs to track transactions (e.g., query parameters)
- Create user-friendly success/failure pages with clear next steps
- Implement proper error handling on failure pages
- Consider using webhooks for reliable order status updates instead of relying solely on return URLs
Step 5: Choose Your Integration Method
ProBuy offers multiple integration methods to suit different technical requirements and platforms:
Nodejs SDK
Recommended
Best for custom websites and web applications. Simple JavaScript integration with full control over the checkout experience.
Quick Start →Direct API Integration
Advanced
Direct REST API access for maximum flexibility. Ideal for complex integrations, custom platforms, or backend systems.
View Direct Guide →Step 6: Set Up Test Environment
Before going live, thoroughly test your integration in the sandbox environment:
Sandbox Environment Details
Supplier Portal (Sandbox)
https://sandboxsupplier.probuy.devCompany Portal (Sandbox)
https://sandboxcompany.probuy.devAPI Base URL (Sandbox)
https://sandboxapi.probuy.devSDK Environment Setting
environment: 'sandbox'Step 7: Go Live Checklist
Before switching to production, ensure you've completed the following:
Pre-Launch Checklist
- Merchant (Supplier) account approved and activated
- Production API token generated and stored securely
- Test transactions completed successfully in sandbox environment
- Return URLs configured and tested (success, failure, cancel)
- SSL certificate installed and HTTPS enabled
- Error handling implemented for all payment scenarios
- Webhook endpoints configured (if using webhooks)
- Order management process defined
- Customer support process for payment issues established
- SDK environment changed from 'sandbox' to 'prod'
- Production API token updated in configuration
- Final testing in production environment completed
Environment URLs Reference
| 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.meNext Steps
Now that you have your account set up and credentials ready, you can start integrating:
Need Help?
If you need assistance during the setup process:
- 📧 Email: [email protected]
- 💬 Contact your account manager
- 📚 Check the integration journey overview
- 📖 Browse the documentation