Getting Started

Prerequisites

• Merchant whitelist access (contact BD team)
• API credentials (API Key & Secret)
• Webhook endpoint for payment notifications

Environment Endpoints

Sandbox Environment (for testing and development)

Base URL: https://openapi-sandbox.allscale.io

Production Environment (for live transactions)

Base URL: https://openapi.allscale.io

---

Quick Start Guide

Step 1: Get Access

Contact BD team for merchant whitelist approval and receive your API credentials.

Step 2: Test Your Integration

Before diving into payment flows, verify your setup with test endpoints:

Follow the Authentication Guide to implement API authentication, then test these endpoints:

1. GET /v1/test/ping - Verify connection and authentication
2. GET /v1/test/fail - Test error handling
3. POST /v1/test/post - Test POST requests with payload

✅ Once all three test routes return expected responses, proceed to Step 3.

See Test Route Documentation for details.

Step 3: Configure Webhooks

• Configure your webhook URL in the merchant dashboard or provide it to BD team
• Implement signature verification (see- Webhook Signing )

Step 4: Implement Payment Flow

Review the Integration Flow and implement:

• Create Checkout Intent
• Query Intent Status

---

API Documentation

Core Concepts

• Authentication - Request signing with API Key & Secret
• Integration Flow - End-to-end payment workflow

Security

• Response Signing - Optional: Verify API response authenticity
• Webhook Signing - Required: Verify webhook callbacks

API Routes

• Test Routes - Verify your integration setup
• Get Checkout Intent - Get intent sessions
• Get Intent Status - Query intent status
• Create Checkout Intent - Create Checkout Intent

---

Support

Contact your BD team for assistance.