🖇️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

Module	Description
Authentication	Request signing using API Key and Secret
Integration Flow	Complete end-to-end payment workflow

Security

Module	Description
Response Signing	Optional: Verify the authenticity of API responses
Webhook Signing	Required: Verify webhook callback signatures

API Routes

Route	Description
Test Routes	Verify your integration setup
Get Checkout Intent	Retrieve intent sessions
Get Intent Status	Query the current intent status
Create Checkout Intent	Create a new checkout intent

---

Support

Contact your BD team for assistance.