Skip to main content

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

smilepayz teamsAbout 2 min

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

面向维护者:编辑 docs/**/reference/brazil/** 时,请与 英文 Pay-In 范本印尼墨西哥菲律宾 等规范对齐,共用 VuePress 客户端增强样式

侧栏维护语言:enidthzh 四套路径需同步。


一、与墨西哥 / 印尼的差异(路径与业务)

巴西墨西哥
支付方式文档根目录 paymentMethod.md根目录 paymentMethod.md
transaction/inquiry/ 链到支付方式../paymentMethod.md../paymentMethod.md
账户类 inquiryinquiryAccountinquiryAccount
币种BRLMXN
Pay-inpaymentMethod 固定 PIXpayer.pixAccount(CPF 11 位 / CNPJ 14 位);expiryPeriod 默认 3600 s,范围 3600–86400SPEI / CODI / OXXO 等
代付cashAccountpaymentMethodCPFCNPJPHONEEMAILEVP 等)+ receiver.taxNumbercashAccount + 银行通道码;无 receiver
时区示例常用 BRT −03:00(巴西利亚)常用 CST −06:00(墨西哥中部)

不得因版式重写删除:BRLPIX、代付 CPF/CNPJ 等与现网一致的业务说明。


二、全局能力

印尼规范 · 第二节


三、HTTP 接口页

范本docs/en/reference/brazil/transaction/payin.md。应对齐:payinpayoutinquiryBalanceinquiryStatusen / id / th / zh 同路径)。

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

四、支付方式页(paymentMethod.md

  • 英文 Method | Type | Description;中文 方式 | 类型 | 描述;印尼语 / 泰文表头可与 EN 一致以便增强逻辑稳定,描述可本地化。
  • 不放置 Logo 图。
  • Pay-In / Pay-Out 描述建议两行(<br>)。

五、适用范围与例外

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

六、合并前自检


七、参考索引

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