> For the complete documentation index, see [llms.txt](https://docs.allscale.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.allscale.io/allscale-checkout/getting-started.md).

# Getting Started

## Prerequisites

* API credentials (API Key & Secret)
* Webhook endpoint for payment notifications

## Environment Endpoints

### **Environment**

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

***

## Quick Start Guide

### **Step 1: Get Access**

1. Register and open <https://app.allscale.io>, then navigate to **Settings → Commerce,** long-press the "Enable now" button to enable Checkout.

<figure><img src="/files/GehfAQfHn9CcMPwqj53n" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/pRVgXTZxzCBrMQkVpfec" alt=""><figcaption></figcaption></figure>

2. After enabling Checkout, you can follow the guidelines to set up your first store, freely choosing the store type and the specific stablecoins you wish to accept.

<figure><img src="/files/hllpdGUQ8A8Gd5uGQIFI" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/4Ng7CyyuxVlaMIyPMyD7" alt=""><figcaption></figcaption></figure>

3. Obtain your API Key and API Secret; please be sure to save your API Secret immediately, then enter the confirmation phrase to successfully create the store.

<figure><img src="/files/ffKjNyBiIw5TTw3HAhos" alt=""><figcaption></figcaption></figure>

**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](/allscale-checkout/api-reference/api-doc-auth.md) Guide to implement API authentication, then [test](/allscale-checkout/api-reference/api-doc-test-route.md) 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](/allscale-checkout/api-reference/api-doc-test-route.md) for details.

**Prefer Postman?** See [Get Started via Postman](/allscale-checkout/quickstart-with-postman.md) — 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

<figure><img src="/files/Uv4UhvsRRxk7ERDCRxDX" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/ADErP8T1WxaPde5NHNGt" alt=""><figcaption></figcaption></figure>

* Implement signature verification (see [**Webhook Signing**](/allscale-checkout/api-reference/api-doc-webhook-signing-and-payload-guide.md))

### **Step 4: Implement Payment Flow**

Review the [Integration Flow](/allscale-checkout/api-reference.md) and implement:

* [Create Checkout Intent](/allscale-checkout/api-reference/api-doc-checkout-intent-routes-create-checkout-intent.md)
* [Query Intent Status](/allscale-checkout/api-reference/api-doc-checkout-intent-routes-get-status.md)

### **Step 5:** Personalize your payment settings

In "Store Settings," you can also adjust payment-related settings according to your preferences

* **Enable Swidge**: Once enabled, you can accept payments in cryptocurrencies other than stablecoins; AllScale will automatically perform a "Swap + Bridge" to convert them into stablecoins and deposit the funds into your account.
* **Pay with Card and Local Payment**: Enabling this feature allows your customers to pay with credit cards and local payment methods, Visa, Mastercard, Apple Pay and more are supported.

<figure><img src="/files/5b4Q2tqM73DdO452GRnL" alt=""><figcaption></figcaption></figure>

* **Claim Link:** Once enabled, you can generate large batches of claim links via the API; simply activate the feature in the settings and specify the amount and blockchain for each link to get started.

<figure><img src="/files/Gj9pQQIVpmfV61trIqNg" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/70wWqifMYNXBRPAVXdz3" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/BZ2tciYL8ocJzx2OJgpH" alt=""><figcaption></figcaption></figure>

In addition, you can configure settings for features such as **Accepted Tokens**, **Webhook signatures**, **Response Signatures**, and **Enable Unique Order ID Check**.

***

## 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**

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

**Tooling**

| Resource                                                | Description                                                               |
| ------------------------------------------------------- | ------------------------------------------------------------------------- |
| Get Started via Postman                                 | Import a pre-signed Postman collection to hit every v1 endpoint instantly |
| [llms-full.txt](https://docs.allscale.io/llms-full.txt) | 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:

```
GET https://docs.allscale.io/allscale-checkout/getting-started.md?ask=<question>
```

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.