Skip to main content

哥伦比亚地区 API 文档 — 编写与展示规范（维护说明）

smilepayz teamsAbout 2 min

哥伦比亚地区 API 文档 — 编写与展示规范（维护说明）

面向维护者：编辑 docs/**/reference/colombia/** 时，请与 英文 Pay-In 范本 及 智利、巴西、墨西哥 等规范对齐，共用 VuePress 客户端增强 与 样式。

侧栏维护语言：en、id、th、zh 四套路径需同步。

一、与智利 / 巴西的差异（路径与业务）

项哥伦比亚智利
币种COP（整数 比索）CLP（整数比索）
支付方式文档根目录 paymentMethod.md根目录 paymentMethod.md
账户类 inquiry无 inquiryAccount无 inquiryAccount
Pay-inCASHIER_CO；payer / payer.name 为 O（可选）CASHIER_CL；payer.name M
代付cashAccount、cashAccountType、paymentMethod、receiver（idType：CC / CE）证件 DNI / CE / PAS / RUT 等
时区示例COT −05:00（哥伦比亚）CLT −03:00

不得因版式重写删除：COP、CASHIER_CO、代付 CC/CE、CORRIENTE/AHORROS 等与现网一致的业务说明。

二、全局能力

同 印尼规范 · 第二节。

三、HTTP 接口页

范本：docs/en/reference/colombia/transaction/payin.md。应对齐：payin、payout、inquiryBalance、inquiryStatus（en / id / th / zh 同路径）。

  • ### Request 下 apifox-endpoint-bar，再 #### Request Path:。
  • 四列表、### Responses、回调 ### Notification/Callback；回调 SUCCESS 使用 :::info Important。
  • 账户划转：../../../guide/feature/transfer.md（勿写死 ../../../../en/...）。
  • 回调 money.amount 若可能与请求不一致，用表内 Markdown 粗体 说明，勿使用 HTML <font>。

四、支付方式页（paymentMethod.md）

  • Pay-Out 代码行数多：英文表可用两行 <br> 压缩；zh / id / th 可用统一模板 + 代码列，与智利策略相同。
  • 不放置 Logo 图。

五、适用范围与例外

路径建议
transaction/payin.md、payout.md按第三节全文。
inquiry/*.md同上。
paymentMethod.md按第四节。
transaction/refund.md、settlement/*、README.md叙述或占位为主，不强制本规范。

六、合并前自检

七、参考索引

用途路径
HTTP 范本en/…/colombia/transaction/payin.md
支付方式en/…/colombia/paymentMethod.md
其他地区印尼、泰国、印度、菲律宾、越南、墨西哥、巴西、智利、秘鲁