ST Pay Merchant APIST Pay Merchant API
Guide
API
Error codes
Back office
AI-assisted integration
  • 繁體中文
  • 简体中文
  • English
Guide
API
Error codes
Back office
AI-assisted integration
  • 繁體中文
  • 简体中文
  • English
  • Getting started

    • Overview
    • Request and response format
    • Authentication and IP whitelist
    • Signature
    • Merchant back office
    • AI-assisted integration
  • API

    • Create a collection order
    • Create a payout order
    • Order query
    • Callback notifications
  • Reference

    • Order status and amounts
    • Duplicate requests and confirming results
    • Error codes
    • Bank codes
    • Go-live checklist

AI-assisted integration

You can give this documentation to an AI coding tool (such as Claude, ChatGPT, Cursor, or GitHub Copilot) and have it help you generate your integration code. This page provides documentation files that an AI can read directly.

Download the documentation files

This documentation can be opened only from whitelisted IPs, so AI tools cannot read it from its URL. Download the files first, then give them to the AI.

FileContentsWhen to use
llms-full.txtAll pages combined into a single Markdown fileUse this file in most cases. It gives the AI the complete rules at once
llms.txtThe documentation's table of contents with a summary of each pageWhen your AI tool has a limited context length and you only want to give it the table of contents

Each page also has a Markdown version, which you can get by replacing .html with .md in the URL. For example, the Markdown version of Create a collection order is at /en/api/collect.md.

Whenever the documentation is updated, download the files again so that the AI does not generate code based on outdated rules.

How to give the files to an AI

Tool typeHow to do it
Chat interfaces (Claude, ChatGPT, etc.)Upload llms-full.txt as an attachment, then describe what you want the AI to do.
Coding tools (Claude Code, Cursor, GitHub Copilot, etc.)Put llms-full.txt in your project, for example as docs/qpay-api.md, and reference this file in the conversation (for example, @docs/qpay-api.md). You can reference it again every time you ask the AI to modify your integration code.

Do not give confidential data to an AI

  • Do not paste your production API secret key into a conversation or upload it to an AI. Have the AI read the key from an environment variable or a configuration file, and for testing, use the sample credential in the signature example or your test environment credential.
  • Do not paste real orders, payer names, receiving account numbers, or similar data into an AI.

Verify AI-generated code

An AI may misunderstand the rules or make its own assumptions. Do not use the generated code directly in the production environment:

  1. The value computed by your signature function must exactly match the signature example.
  2. Actually call every API in the test environment, including error cases (for example, a duplicate merchant order number or an amount outside the limits).
  3. Verify every item on the Go-live checklist.
  4. If what the AI says is inconsistent with this documentation, this documentation prevails. Where the documentation is not clear, contact your ST Pay integration contact.
Prev
Merchant back office