巴西地区 API 文档 — 编写与展示规范(维护说明)
About 2 min
巴西地区 API 文档 — 编写与展示规范(维护说明)
面向维护者:编辑 docs/**/reference/brazil/** 时,请与 英文 Pay-In 范本 及 印尼、墨西哥、菲律宾 等规范对齐,共用 VuePress 客户端增强 与 样式。
侧栏维护语言:en、id、th、zh 四套路径需同步。
一、与墨西哥 / 印尼的差异(路径与业务)
| 项 | 巴西 | 墨西哥 |
|---|---|---|
| 支付方式文档 | 根目录 paymentMethod.md | 根目录 paymentMethod.md |
从 transaction/、inquiry/ 链到支付方式 | ../paymentMethod.md | ../paymentMethod.md |
| 账户类 inquiry | 无 inquiryAccount | 无 inquiryAccount |
| 币种 | BRL | MXN |
| Pay-in | paymentMethod 固定 PIX;payer.pixAccount(CPF 11 位 / CNPJ 14 位);expiryPeriod 默认 3600 s,范围 3600–86400 | SPEI / CODI / OXXO 等 |
| 代付 | cashAccount、paymentMethod(CPF、CNPJ、PHONE、EMAIL、EVP 等)+ receiver.taxNumber | cashAccount + 银行通道码;无 receiver |
| 时区示例 | 常用 BRT −03:00(巴西利亚) | 常用 CST −06:00(墨西哥中部) |
不得因版式重写删除:BRL、PIX、代付 CPF/CNPJ 等与现网一致的业务说明。
二、全局能力
同 印尼规范 · 第二节。
三、HTTP 接口页
范本:docs/en/reference/brazil/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)
- 英文
Method | Type | Description;中文方式 | 类型 | 描述;印尼语 / 泰文表头可与 EN 一致以便增强逻辑稳定,描述可本地化。 - 不放置 Logo 图。
- Pay-In / Pay-Out 描述建议两行(
<br>)。
五、适用范围与例外
| 路径 | 建议 |
|---|---|
transaction/payin.md、payout.md | 按第三节全文。 |
inquiry/*.md | 同上。 |
paymentMethod.md | 按第四节。 |
transaction/refund.md、settlement/*、README.md | 叙述或占位为主,不强制本规范。 |
六、合并前自检
七、参考索引
| 用途 | 路径 |
|---|---|
| HTTP 范本 | en/…/brazil/transaction/payin.md |
| 支付方式 | en/…/brazil/paymentMethod.md |
| 其他地区 | 印尼、泰国、印度、菲律宾、越南、墨西哥、智利、哥伦比亚、秘鲁 |
