Getting Started
Prerequisites
API credentials (API Key & Secret)
Webhook endpoint for payment notifications
Environment Endpoints
Environment
Base URL: https://openapi.allscale.ioQuick Start Guide
Step 1: Get Access
Register your merchant account at https://app.allscale.io, then navigate to Settings → Commerce to enable Checkout and retrieve your API credentials.
Optional: One-Click Setup with AI
Using Claude Code, Cursor, Windsurf, or any AI coding assistant? Just tell it:
read and install allscale.io/skill
Your AI will fetch the guide and wire up authentication, intent creation, and webhook verification automatically.
You can also point your assistant at https://docs.allscale.io/llms-full.txt — a single-file dump of the entire API documentation, optimized for LLM ingestion.
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:
GET /v1/test/ping - Verify connection and authentication
GET /v1/test/fail - Test error handling
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.
Prefer Postman? See Get Started via Postman — import the collection, paste your keys, and every v1 endpoint is one click away with HMAC signing already wired up. No signing code required.
Step 3: Configure Webhooks
Configure your webhook URL in the merchant dashboard
Implement signature verification (see Webhook Signing)
Step 4: Implement Payment Flow
Review the Integration Flow and implement:
API Documentation
Single-File Reference for AI Tools
If you're using an AI coding assistant or want the entire API spec in one place, fetch https://docs.allscale.io/llms-full.txt — every doc page concatenated into a single LLM-friendly text file.
Core Concepts
Authentication
Request signing using API Key and Secret
Integration Flow
Complete end-to-end payment workflow
Security
Response Signing
Optional: Verify the authenticity of API responses
Webhook Signing
Required: Verify webhook callback signatures
API Routes
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
Tooling
Get Started via Postman
Import a pre-signed Postman collection to hit every v1 endpoint instantly
Full API documentation as a single file, for AI assistants
Support
Contact your Relationship Manager for assistance.
Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the ask query parameter:
The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
For bulk ingestion (loading the full spec into an AI assistant or local tooling), prefer https://docs.allscale.io/llms-full.txt — it ships every doc page as a single text file.
Last updated