巴西 boleto 验证器 API

API ID 13930

验证巴西支付单(银行单据和公用事业/税单),核实校验位,提取银行、金额和到期日,并在数字行和条形码之间转换

835 ms 平均响应

API 文档

端点

请求
“验证一个 boleto”端点检查巴西 boleto(条形码或可数字化行)是否格式正确,使用官方 FEBRABAN 校验位算法。它返回校验位是否有效,连同从 boleto 数据中提取的发卡银行、付款金额和到期日期。此端点不验证付款状态,不与任何银行或金融机构确认 boleto,也不保证 boleto 無欺诈 - 仅进行数学验证,而不是实时金融检查
Endpoint ID: 32113
GET https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32113/validate+a+boleto
输入参数

验证一个 boleto — 端点功能

对象 描述
code 必需 Boleto barcode (44 digits) or digitable line (47 or 48 digits). Dots, dashes and spaces are ignored. Alternatively send it in the JSON body.

剩余免费测试请求:3 / 3。


输入参数

code
API 示例响应
JSON
{
    "valid": true,
    "type": "bank_slip",
    "input_format": "digitable_line",
    "barcode": "21299758700000020000001121100012100447561740",
    "digitable_line": "21290001192110001210904475617405975870000002000",
    "digitable_line_formatted": "21290.00119 21100.012109 04475.617405 9 75870000002000",
    "checks": {
        "field_1_dv": true,
        "field_2_dv": true,
        "field_3_dv": true,
        "barcode_dv": true
    },
    "errors": [],
    "warnings": [],
    "bank": {
        "code": "212",
        "name": "Banco Original"
    },
    "currency": "BRL",
    "segment": null,
    "amount_cents": 2000,
    "amount": "20.00",
    "due_date": "2018-07-16",
    "due_date_status": "ok",
    "overdue": true
}
验证一个 boleto — 代码片段

curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32113/validate+a+boleto?code=21290.00119 21100.012109 04475.617405 9 75870000002000' --header 'Authorization: Bearer YOUR_API_KEY' 


    
请求
将巴西 boleto 在其两种表示形式之间转换:44位条形码和47/48位可数字化线路。接受任一种格式作为输入,并以两种格式返回 boleto。 boleto 的校验位必须有效才能成功转换,如果无效,此端点将返回错误而不是转换结果
Endpoint ID: 32115
GET https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32115/convert+between+digitable+line+and+barcode
输入参数

在数字线与条形码之间转换 — 端点功能

对象 描述
code 必需 Boleto barcode (44 digits) or digitable line (47 or 48 digits). Dots, dashes and spaces are ignored. Alternatively send it in the JSON body.

剩余免费测试请求:3 / 3。


输入参数

code
API 示例响应
JSON
{
    "converted": true,
    "type": "bank_slip",
    "barcode": "21299758700000020000001121100012100447561740",
    "digitable_line": "21290001192110001210904475617405975870000002000",
    "digitable_line_formatted": "21290.00119 21100.012109 04475.617405 9 75870000002000"
}
在数字线与条形码之间转换 — 代码片段

curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32115/convert+between+digitable+line+and+barcode?code=21290.00119 21100.012109 04475.617405 9 75870000002000' --header 'Authorization: Bearer YOUR_API_KEY' 


    
请求
根据三位数的COMPE代码查找巴西银行(例如,伊塔乌是341,巴西银行是001),并返回其名称。查询表仅涵盖知名银行,且不是详尽无遗——未识别的代码返回404,这并不意味着票据本身无效,只是说明该银行不在列表中
Endpoint ID: 32117
GET https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32117/look+up+a+bank+by+its+3-digit+compe+code
输入参数

剩余免费测试请求:3 / 3。

API 示例响应
JSON
{
    "code": "341",
    "name": "Itaú Unibanco"
}
通过其3位数的COMPE代码查找银行 — 代码片段

curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32117/look+up+a+bank+by+its+3-digit+compe+code&code=Required' --header 'Authorization: Bearer YOUR_API_KEY' 


    

API 访问密钥和身份验证

注册后,每个开发者都会被分配一个个人 API 访问密钥,这是一个唯一的字母和数字组合,用于访问我们的 API 端点。要使用 巴西 boleto 验证器 API 进行身份验证,只需在 Authorization 标头中包含您的 bearer token。

标头
标头 描述
授权 必需 应为 Bearer access_key. 订阅后,请查看上方的"您的 API 访问密钥"。

无长期承诺。随时升级、降级或取消。 免费试用包括最多 50 个请求。

(年度计费可节省 2 个月 🎉)

🚀 企业版套餐

起价
$ 10,000/年


  • 自定义数量
  • 自定义速率限制
  • 专业客户支持
  • 实时 API 监控

概览

验证巴西账单(银行汇款单和公用事业/税单),验证校验位,提取银行、金额和到期日期,并在可打印行和条形码之间转换

巴西 boleto 验证器 API FAQs

每个端点返回包含关于巴西 boleto 的信息的 JSON 数据,包括验证结果、银行详情、支付金额、到期日期和数字线与条形码之间的转换结果

关键字段包括“有效”(布尔值),“银行”(包含“代码”和“名称”的对象),“金额”(字符串),“到期日”(字符串)和“支票”(详细说明支票数字验证的对象)这些字段提供了关于票据有效性和细节的基本信息

返回的数据以JSON格式结构化,复杂数据采用嵌套对象。例如“bank”字段是一个包含“code”和“name”的对象,而“checks”提供每个校验位的验证结果

每个端点提供有关票据验证的信息,包括校验位验证、发卡行详细信息、支付金额、到期日期,以及数字化线和条形码之间的转换

GET和POST验证端点接受条形码或数字行格式的 boleto 转换端点接受任一格式作为输入确保校验位有效以便成功转换

响应数据组织成键值对,主要验证结果位于顶层,详细信息(如银行信息和支票)嵌套在特定对象中,便于访问相关数据

典型的用例包括在处理支付前验证巴西票据的完整性 为用户方便进行格式转换 以及根据COMPE代码查找银行信息用于金融应用

通过使用官方的FEBRABAN校验位算法进行验证,维护数据准确性。API进行数学检查而不依赖外部数据源,确保结果的一致性和可靠性

一般常见问题

Zyla API Hub 就像一个大型 API 商店,您可以在一个地方找到数千个 API。我们还为所有 API 提供专门支持和实时监控。注册后,您可以选择要使用的 API。请记住,每个 API 都需要自己的订阅。但如果您订阅多个 API,您将为所有这些 API 使用相同的密钥,使事情变得更简单。
价格以 USD(美元)、EUR(欧元)、CAD(加元)、AUD(澳元)和 GBP(英镑)列出。我们接受所有主要的借记卡和信用卡。我们的支付系统使用最新的安全技术,由 Stripe 提供支持,Stripe 是世界上最可靠的支付公司之一。如果您在使用卡片付款时遇到任何问题,请通过 [email protected]

此外,如果您已经以这些货币中的任何一种(USD、EUR、CAD、AUD、GBP)拥有有效订阅,该货币将保留用于后续订阅。只要您没有任何有效订阅,您可以随时更改货币。
定价页面上显示的本地货币基于您 IP 地址的国家/地区,仅供参考。实际价格以 USD(美元)为单位。当您付款时,即使您在我们的网站上看到以本地货币显示的等值金额,您的卡片对账单上也会以美元显示费用。这意味着您不能直接使用本地货币付款。
有时,银行可能会因其欺诈保护设置而拒绝收费。我们建议您首先联系您的银行,检查他们是否阻止了我们的收费。此外,您可以访问账单门户并更改关联的卡片以进行付款。如果这些方法不起作用并且您需要进一步帮助,请通过 [email protected]
价格由月度或年度订阅决定,具体取决于所选计划。
API 调用根据成功请求从您的计划中扣除。每个计划都包含您每月可以进行的特定数量的调用。只有成功的调用(由状态 200 响应指示)才会计入您的总数。这确保失败或不完整的请求不会影响您的月度配额。
Zyla API Hub 采用月度订阅系统。您的计费周期将从您购买付费计划的那一天开始,并在下个月的同一日期续订。因此,如果您想避免未来的费用,请提前取消订阅。
要升级您当前的订阅计划,只需转到 API 的定价页面并选择您要升级到的计划。升级将立即生效,让您立即享受新计划的功能。请注意,您之前计划中的任何剩余调用都不会转移到新计划,因此在升级时请注意这一点。您将被收取新计划的全部金额。
要检查您本月剩余多少 API 调用,请参考响应标头中的 "X-Zyla-API-Calls-Monthly-Remaining" 字段。例如,如果您的计划允许每月 1,000 个请求,而您已使用 100 个,则响应标头中的此字段将显示 900 个剩余调用。
要查看您的计划允许的最大 API 请求数,请检查 "X-Zyla-RateLimit-Limit" 响应标头。例如,如果您的计划包括每月 1,000 个请求,此标头将显示 1,000。
"X-Zyla-RateLimit-Reset" 标头显示您的速率限制重置之前的秒数。这告诉您何时您的请求计数将重新开始。例如,如果它显示 3,600,则意味着还有 3,600 秒直到限制重置。
是的,您可以随时通过访问您的账户并在账单页面上选择取消选项来取消您的计划。请注意,升级、降级和取消会立即生效。此外,取消后,您将不再有权访问该服务,即使您的配额中还有剩余调用。
为了让您有机会在没有任何承诺的情况下体验我们的 API,我们提供 7 天免费试用,允许您免费进行最多 50 次 API 调用。此试用只能使用一次,因此我们建议将其应用于您最感兴趣的 API。虽然我们的大多数 API 都提供免费试用,但有些可能不提供。试用在 7 天后或您进行了 50 次请求后结束,以先发生者为准。如果您在试用期间达到 50 次请求限制,您需要"开始您的付费计划"以继续发出请求。您可以在个人资料中的订阅 -> 选择您订阅的 API -> 定价标签下找到"开始您的付费计划"按钮。或者,如果您在第 7 天之前不取消订阅,您的免费试用将结束,您的计划将自动计费,授予您访问计划中指定的所有 API 调用的权限。请记住这一点以避免不必要的费用。
7 天后,您将被收取试用期间订阅的计划的全额费用。因此,在试用期结束前取消很重要。因忘记及时取消而提出的退款请求不被接受。
当您订阅 API 免费试用时,您可以进行最多 50 次 API 调用。如果您希望超出此限制进行额外的 API 调用,API 将提示您执行"开始您的付费计划"。您可以在个人资料中的订阅 -> 选择您订阅的 API -> 定价标签下找到"开始您的付费计划"按钮。
付款订单在每月 20 日至 30 日之间处理。如果您在 20 日之前提交请求,您的付款将在此时间范围内处理。
您可以通过我们的聊天渠道联系我们以获得即时帮助。我们始终在线,时间为上午 8 点至下午 5 点(EST)。如果您在该时间之后联系我们,我们将尽快回复您。此外,您可以通过 [email protected]