巴西
大约 2 分钟
国家域名及编码（巴西）
| 国家/地区 | 国家编码 | 域名 | 货币代码 | 货币名称 |
|---|---|---|---|---|
| 巴西 | br | global-br-openapi.toppayment.com | BRL | 巴西雷亚尔 |
域名：推荐使用统一域名
openapi.toppayment.com（路径不变）；原国别域名仍可继续使用。
实际域名与商户环境以运营配置为准；路径模板与其他国家一致：/sandbox/{countryCode}/...（沙箱）、/{countryCode}/...（生产）。
代收支付方式编码
调用巴西代收接口（/pay/prePay，域名/国家码见上表）时，在 method 传递下列编码（与渠道 BrazilMethodEnum 一致）。开放接口字段及示例见 代收订单-巴西。
| 支付方式编码 | 说明 |
|---|---|
| PIX | PIX |
若网关扩展更多 method，以接口返回与运营下发清单为准。
金额格式（代收 / 代付）
正数金额，整数或最多两位小数；不允许全 0；不允许三位及以上小数。各接口请求体中的 amount 说明见 代收订单-巴西、代付订单-巴西。
代付 PIX 字段映射
巴西代付走 PIX 时，通用请求体字段与业务含义对应关系如下。代付下单请求体及示例见 代付订单-巴西。
| 开放接口字段 | 含义 |
|---|---|
accountName | 收款人姓名（业务侧常作 name） |
bankCode | PIX 类型（业务侧常作 pixType），取值见下表，忽略大小写 |
bankCard | PIX 账号 / 密钥值（业务侧常作 pixAccount） |
taxNumber | 可选；有值时去非数字后须为 11 位（CPF） 或 14 位（CNPJ） |
收款人姓名（accountName）
- 必填，最长 50 个字符。
- 仅允许 Unicode 字母、数字、空格。
PIX 类型（bankCode）与展示名
与 BrazilBankEnum 一致，用于代付 bankCode（pixType） 与展示 bankName：
| bankCode | bankName |
|---|---|
| CPF | CPF |
| CNPJ | CNPJ |
| PHONE | PHONE |
| EVP | EVP |
按 PIX 类型校验 bankCard（pixAccount）
| bankCode | bankCard（pixAccount）要求 |
|---|---|
| CPF | 去非数字后须为 11 位数字 |
| CNPJ | 去非数字后须为 14 位数字 |
| PHONE | 可先去掉空格；须以 +55 开头，后跟 10～11 位数字 |
| 符合标准邮箱格式 | |
| EVP | 32 位字母数字（[a-zA-Z0-9]{32}） |
代收与代付订单 status 字段取值说明见 交易状态码。