Skip to main content

泰国地区 API 文档 — 编写与展示规范(维护说明)

smilepayz teamsAbout 3 min

泰国地区 API 文档 — 编写与展示规范(维护说明)

面向维护者:编辑 docs/**/reference/thailand/** 下内容时,请按本文与 英文 Pay-In 范本 对齐,并与 印尼地区规范 共用同一套 VuePress 增强(client样式)。


一、与印尼的差异(路径与业务)

泰国印尼
支付方式文档路径根目录 paymentMethod.md(无 method/ 子目录)method/paymentMethod.md
transaction/inquiry/ 链到支付方式../paymentMethod.md../method/paymentMethod.md
账户查询inquiryAccountinquiryAccount
币种 / Pay-in 通道THB;请求里 paymentMethodQRPAYKBANK(以接口页为准)IDR;多通道见印尼支付方式表

不得因版式重写删除:payer(含 nameaccountNobankName)、THBQRPAY/KBANK 等与现网一致的业务说明(金额上下限以产品为准时可不在正文写死)。


二、全局能力

印尼规范 · 第二节 相同:四列表增强、支付方式三列表、apifox-endpoint-bar 样式等。


三、HTTP 接口页(transaction/inquiry/

范本docs/en/reference/thailand/transaction/payin.md。应对齐的文件:payinpayoutinquiryBalanceinquiryStatus(各语言同路径)。

3.1 文首与 Endpoint

  • Frontmatter 后先写短说明(泰国场景、THB、关键支付方式等),再 ### Request
  • apifox-endpoint-bar 紧接在 ### Request 下、#### Request Path: 上;path 使用文档中的真实相对路径(如 /v2.0/transaction/pay-in),从印尼页照抄业务 path。

3.2 章节顺序与四列表

与印尼文档 第三节 3.3–3.43.4 一致:### Responses(复数)、Field 列反引号、Required 为 M/O/C、示例 tabs 的 @tab Header 仅请求头等。

3.3 链接深度

docs/{locale}/reference/thailand/transaction/inquiry/ 到产品文档:../../../product/...;到支付方式:../paymentMethod.md。状态查询页内链到支付方式时写 ../paymentMethod.md不要../method/paymentMethod.md)。

3.4 回调章节标题

与印尼对齐时使用 ### Notification/Callback;返回体说明使用 :::info(小写 info)。


四、侧栏标题(title

建议使用可读短标题(如 Pay-in collection、Disbursement (pay-out)、Balance inquiry、Transaction status),避免 API PAYIN 类全大写。


五、支付方式页(paymentMethod.md

  • 三列表:英文 Method | Type | Description;中文 方式 | 类型 | 描述;泰文 วิธี | ประเภท | คำอธิบาย
  • Supported 小节:说明 Method 列 = 请求中的 paymentMethod(泰国页不放置 Logo 图)。
  • Pay-In / Pay-Out 描述建议各约两行(<br>),与印尼页风格一致。
  • 批量压短 Pay-Out 描述时,可对泰国路径执行:
node scripts/shorten-payout-descriptions.mjs docs/en/reference/thailand/paymentMethod.md

(脚本识别 ## Pay-Out 等标题;若表内已是两行 <br> 格式则会跳过。)


六、适用范围与例外

路径建议
transaction/payin.mdpayout.md按第三节全文。
inquiry/inquiryBalance.mdinquiry/inquiryStatus.md同上。
paymentMethod.md按第五节。
settlement/*.mdREADME.md叙述为主,不强制 endpoint 条与四列表。

七、合并前自检清单


八、参考文件索引

用途路径
HTTP 范本en/…/thailand/transaction/payin.md
代付en/…/thailand/transaction/payout.md
查询en/…/thailand/inquiry/
支付方式en/…/thailand/paymentMethod.md
印尼对照indonesia-api-doc-style.md
印度对照india-api-doc-style.md
菲律宾对照philippines-api-doc-style.md
越南对照vietnam-api-doc-style.md
墨西哥对照mexico-api-doc-style.md
巴西对照brazil-api-doc-style.md
智利对照chile-api-doc-style.md
哥伦比亚对照colombia-api-doc-style.md
秘鲁对照peru-api-doc-style.md