PingPongCheckout documentation supports the llms.txt protocol, allowing AI coding tools to directly access API documentation for more accurate code suggestions and API call assistance.

What is llms.txt

llms.txt is a documentation standard designed for LLMs (Large Language Models), providing structured document indexes that enable AI tools to:

• Quickly discover documentation structure
• Get detailed descriptions of specific APIs
• Understand parameter definitions and response formats

File Locations

File	Path	Description
llms.txt	/llms.txt	Language index entry for discovery files
Chinese llms.txt	/zh/llms.txt	Chinese documentation directory index (concise)
English llms.txt	/en/llms.txt	English documentation directory index (concise)
llms-full.txt	/llms-full.txt	Full-content language index entry
Chinese llms-full.txt	/zh/llms-full.txt	Full Chinese documentation content
English llms-full.txt	/en/llms-full.txt	Full English documentation content
OpenAPI Spec	/api/openapi.json	OpenAPI 3.1.0 specification
API Index	/api/index.json	All API endpoints index

AI Tool Integration

Cursor

Create a .cursorrules file in your project root:

When calling PingPongCheckout APIs, refer to the following documentation:
- English Documentation Index: https://acquirer-api-docs-v4-en.pingpongx.com/en/llms.txt
- OpenAPI Specification: https://acquirer-api-docs-v4-en.pingpongx.com/api/openapi.json

Windsurf

Add to .windsurfrules:

PingPongCheckout API Documentation:
- https://acquirer-api-docs-v4-en.pingpongx.com/en/llms.txt
- https://acquirer-api-docs-v4-en.pingpongx.com/api/openapi.json

Claude Code

Configure in CLAUDE.md:

## API Documentation Reference

When consulting PingPongCheckout API:
1. Prefer /en/llms.txt for the English documentation directory
2. Read /api/openapi.json for API specification
3. Follow .md links in the directory for detailed documentation

Generic HTTP Access

Any AI tool supporting HTTP requests can directly fetch:

# Get language index
curl https://acquirer-api-docs-v4-en.pingpongx.com/llms.txt

# Get English documentation directory
curl https://acquirer-api-docs-v4-en.pingpongx.com/en/llms.txt

# Get OpenAPI specification
curl https://acquirer-api-docs-v4-en.pingpongx.com/api/openapi.json

# Get API index
curl https://acquirer-api-docs-v4-en.pingpongx.com/api/index.json

API Specification Files

OpenAPI Specification

/api/openapi.json contains the complete OpenAPI 3.1.0 specification:

• All API endpoint definitions
• Request parameters and response formats
• Authentication methods
• Error code definitions

API Index

/api/index.json provides a quick API endpoint index:

{
  "version": "1.0.0",
  "count": 37,
  "apis": [
    {
      "id": "en-v4-payment-prePay",
      "name": "Checkout Pre-order (Hosted Mode)",
      "path": "/v4/payment/prePay",
      "method": "POST",
      "jsonUrl": "/api/en/en-v4-payment-prePay.json",
      "mdUrl": "/api/en/en-v4-payment-prePay.md"
    }
  ]
}

Best Practices

1. Prefer OpenAPI Specification - Get complete type definitions and parameter constraints
2. Prefer Locale-specific llms.txt - Use /en/llms.txt or /zh/llms.txt to avoid an extra language-index hop
3. Cache Documentation Content - Avoid repeated requests and improve response speed

Supported AI Tools

Tool	Integration Method	Support Level
Cursor	.cursorrules	✅ Fully Supported
Windsurf	.windsurfrules	✅ Fully Supported
Claude Code	CLAUDE.md	✅ Fully Supported
Cline	.clinerules	✅ Fully Supported
GitHub Copilot	-	⚠️ Manual Configuration Required

Previous pagePayment Notification Integration Guide

Next pageSkill Installation