1. API 指南
🇨🇳 中文（简体）
  • 🇺🇸 English
  • 🇪🇸 Español
  • 🇨🇳 中文（简体）
  • Cobre 简介
    • 欢迎
    • 快速入门
    • 将 Cobre 文档接入 AI
    • 产品
      • 本地支付
        • 使用 Cobre 进行本地支付
        • 存款
          • 哥伦比亚
            • 退房
            • 请求支付
            • 通过 Nequi 进行直接扣款
            • 静态 Bre-B 键
            • 转入 (Transfer-In)
          • 墨西哥
            • 请求支付
            • 基于 CLABE 的虚拟余额账户
            • 虚拟 CLABEs
        • 支付
          • 哥伦比亚
            • 通过 Bre-B 进行资金划转
            • 通过 Cobre Fast Pay 进行资金划转
          • 墨西哥
            • 通过 CLABEs 和 SPEI 卡进行资金划转
          • Multi-region
            • 资金划转调度器
        • 其他功能
          • 批量资金划转
          • 启用审批工作流（双人复核）
      • 跨境支付
        • 使用 Cobre 进行跨境支付
      • 连接
        • 通过 Cobre 关联银行账户
      • 稳定币
        • 以稳定币进行全球 PayOuts
    • 其他功能
      • 账户核验
      • 通知与订阅
      • Cobre 安全保障
      • 性能与吞吐量
    • 使用 Cobre
      • 使用您生态系统中的支付工具进行 Bre-B PayOuts
      • 面向贷款机构的 Cobre
      • 通过 ERP 系统集成 Cobre
  • 网络门户
    • 简介与快速入门
    • 门户身份认证
    • 问题排查与支持
    • Movements
      • 审批流程（双人复核）
      • 本地资金划转
      • 单笔付款发起
      • 批量资金划转发起
      • 跨境资金划转
      • 支付链接
      • 调度程序
    • Transactions
      • 交易
    • Accounts
      • 账户与余额管理
      • 账户引用
        • 虚拟 CLABE
        • 转账账户（转入）
    • Counterparties
      • 交易对手
    • Reports
      • 报表与对账
    • Settings
      • 用户与角色管理
      • 安全与管控
    • Developers
      • 订阅管理
  • 开发者
    • API 指南
      • 快速入门
      • Authentication
      • Cobre Balances
        • 管理虚拟余额账户（Cobre Balances）
        • 账户关联
      • Connect Accounts
        • 管理 Connect Accounts
      • Counterparties
        • 管理 Counterparties
      • Local Payments
        • 资金流动
        • Payouts
          • Colombia
            • Fast Pay & ACH
            • Bre-B
          • Mexico
            • SPEI
          • Cross-Region
            • 批量资金流动审批
            • 资金流动调度器
            • 批量资金流动
          • Global
            • 稳定币全球收款
        • Payins
          • Colombia
            • Cobre Keys 与 Bre-B 集成
            • Checkout
            • Direct Link
            • Direct Debit
            • Transfer-In
          • Mexico
            • Direct Link
            • 账户参考——虚拟 CLABE
      • 跨境支付
        • 跨境支付
        • 创建 FX 报价
        • 创建跨境资金流动
        • 为您的全球 Cobre Balance 充值
      • 跨功能特性
        • 账户核验
        • 使用 Cobre Reports 在哥伦比亚进行对账
        • Reports
        • 报告调度器
        • Evidence API
        • 通知与订阅
        • FX 汇率提醒
      • 错误处理
        • 错误码字典
      • Testing
        • 通用测试说明
        • 测试用例
        • 测试 PSE 与 Bancolombia
      • Certification
        • 认证流程
        • Questionnaire
    • API Explorer
      • Authentication API
        • 身份验证
      • Cobre Balances
        • 创建或关联账户
        • 获取所有账户
        • 获取单个账户
        • 更新账户
        • 关闭 Cobre Balance
        • 获取单个账户交易记录
        • 查询单笔交易
        • 获取全部交易记录
        • 获取账户每日余额历史记录
        • Assign or Change Primary Account
        • Unlinking Primary Account
      • Account Verifications
        • 创建账户核验
        • 获取单条账户核验记录
        • 获取所有账户核验记录
      • Account References
        • 创建 Account Reference
        • 查询单条 Account Reference
        • 查询所有 Account References
        • 删除账户引用
        • 为您的账户引用生成证书
      • Cobre Keys
        • 创建 Key
        • 获取所有 Keys
        • 获取单个 Key
        • 注销 Key
        • 封禁或重新激活 Keys
      • Counterparties
        • 账户借记注册
          • 为 Direct Debit 注册 Counterparty
          • 获取所有注册记录
          • 获取单条注册记录
        • 创建 Counterparty
        • 获取单个 Counterparty
        • 获取所有 Counterparties
        • 删除 Counterparty
      • Money Movement Scheduler
        • 创建 Money Movement Scheduler
        • 列出所有 Money Movement Schedulers
        • 取消活跃的 Scheduler
      • Bulk Money Movement
        • 创建 Bulk Money Movement
        • 列出所有 Bulk Money Movements
        • 查询单条 Bulk Money Movement
      • Cross Border
        • 创建 FX 报价
        • 获取单条 FX 报价
        • 获取所有 FX 报价
        • 创建跨境资金划转
        • 获取单条跨境资金划转记录
        • 获取所有 Cross Border Money Movements
      • Checkout
        • 创建 Checkout
        • 获取单个 Checkout
        • 获取所有 Checkouts
        • 停用 Checkout
      • Evidence API
        • 证明材料请求
          • 获取证明材料请求
          • 搜索证明材料请求
        • 证明材料文件
          • 生成上传链接
          • 生成下载链接
        • 证明材料信息
          • 提交证明材料信息
      • Report Scheduler
        • 创建 Report Scheduler
        • 获取所有 Report Schedulers
        • 删除 Report Scheduler
      • Reports
        • 创建报告
        • 获取所有报告
        • 为所选报告生成下载链接
        • 创建 Cobre Balance 对账单
      • 资金流动
        • 创建资金流动
        • 查询单条资金流动记录
        • 查询所有资金流动记录
        • 查询单条 Money Movement
      • Bulk Money Movement 审批
        • Bulk Money Movements 审批决策
      • 资金流动审批
        • 审批资金流动
        • 列出所有资金流动审批
      • 通知与订阅
        • 订阅事件
        • 获取所有订阅
        • 删除订阅
        • 列出所有可用事件
      • Alerts
        • 创建告警
        • 获取所有告警
        • 获取单个告警
        • 停用告警
    • 平台目录
      • 哥伦比亚银行代码
      • 墨西哥银行代码
      • 账户服务商
      • 交易类型
      • 资金流动状态
    • 测试 API
      • 交易调整（QA）
      • 变更资金流动状态（QA）
    • 报告格式
      • 资金流动报告格式
        • 所有资金流动记录 (CSV)
        • 所有资金流动记录 (JSON)
        • SPEI 资金流动记录 (CSV)
        • LEGACY 资金流动记录 (CSV)
      • 交易记录布局
        • 所有交易记录 (CSV)
        • 所有交易记录 (JSON)
        • 虚拟余额账户 (Cobre Balance) 对账单 (PDF)
      • Counterparties 布局
        • 所有 Counterparties (CSV)
      • Multicash 布局
        • Multicash 标题行 (TXT)
        • Multicash 明细行 (TXT)
    • 通知布局
      • 账户事件
        • 账户余额借记
        • 账户余额贷记
      • Cobre Keys
        • Cobre Keys
      • Counterparties
        • Counterparties
      • 资金流动
        • 资金流动
      • 批量资金流动
        • 批量资金流动
      • 跨境资金划转
        • 跨境资金划转
      • Evidence Requests
        • Evidence Requests
      • Reports
        • Reports
      • Alerts
        • FX Alerts
      • 账户引用
        • 账户引用
  • Schemas
    • Counterparties
      • Colombia
        • PayOut
          • Counterparty | Create Metadata Type Cobre Balance (CO)
          • Counterparty | Response Metadata Type Cobre Balance (CO)
          • Counterparty | Create Metadata Type Breb Key (CO)
          • Counterparty | Response Metadata Type Breb Key (CO)
          • Counterparty | Create Metadata Type QR (CO)
          • Counterparty | Response Metadata Type QR (CO)
          • Counterparty | Create Metadata Type CC (CO)
          • Counterparty | Create Metadata Type CH (CO)
          • Counterparty | Create Metadata Type DP (CO)
          • Counterparty | Response Metadata Type CC (CO)
          • Counterparty | Response Metadata Type CH (CO)
          • Counterparty | Response Metadata Type DP (CO)
        • PayIn
          • Counterparty | Response Metadata Type r2p (CO)
          • Counterparty | Create Metadata Type r2p (CO)
          • Counterparty | Create Metadata Type r2p Breb (CO)
          • Counterparty | Response Metadata Type r2p Breb (CO)
        • Secondary Counterparty
          • Secondary Counterparty Create Request
          • Secondary Counterparty Create Response (CO)
          • Secondary Counterparty Create Metadata Type NP (CO)
          • Secondary Counterparty Request Metadata Type LE
          • Secondary Counterparty Response Metadata Type NP (CO)
          • Secondary Counterparty Response Metadata Type LE (CO)
        • Direct Debit
          • Direct Debit Registration | Response
          • Direct Debit Registration | List All Items
        • Counterparty | Create Request (CO)
        • Counterparty | Create Response (CO)
      • Mexico
        • PayOut
          • Counterparty | Create Metadata Type Clabe (MX)
          • Counterparty | Create Metadata Type SPEI Card (MX)
          • Counterparty | Response Metadata Type Clabe (MX)
          • Counterparty | Response Metadata Type SPEI Card (MX)
        • PayIn
          • Counterparty | Create Metadata Type r2p (MX)
          • Counterparty | Response Metadata Type r2p (MX)
        • Counterparty | Create Response (MX)
        • Counterparty | Create Request (MX)
        • Counterparty | Money Movement Return (MX)
      • Global
        • Counterparty | Global CP Request
        • Counterparty | Global Deposit NP request
        • Counterparty | Global Deposit NP response
        • Counterparty | Global Deposit LE request
        • Counterparty | Global Deposit LE response
        • Counterparty | Global CP Response
      • USA
        • Counterparty | Create Request (USA)
        • Counterparty | Create Response (USA)
        • Request Medatata Business
        • Response Medatata Business
        • Request Medatata Individual
        • Response Medatata Individual
      • Counterparty | List All Items
    • Transactions
      • Global
        • Transaction | Credit Cross Border
        • Transaction | Debit Cross Border
      • Colombia
        • Debit
          • Transaction | Debit FI (CO) (col_debit)
          • Transaction | Debit Cobre Balance (CO)
          • Transaction | Debit Breb (CO) (breb_debit)
        • Credit
          • Transaction | Credit Direct Debit (CO) (dd_credit)
          • Transaction | Rejected Breb (breb_rejected)
          • Transaction | Credit Top Up (CO) (col_top_up_credit)
          • Transaction | Credit FI (CO) (col_credit)
          • Transaction | Credit Cobre Balance (CO) (col_cb_credit)
          • Transaction | Credit r2p (r2p_credit)
          • Transaction | Credit Breb (CO) (breb_credit)
          • Transaction | Credit r2p Breb (CO) (r2p_breb_credit)
        • Transaction | Connect Obtain (CO)
        • Transaction | Cobre Balance Obtain (CO)
      • Mexico
        • Debit
          • Transaction | Debit SPEI (MX) (spei_debit)
          • Transaction | Debit FI (MX) (mex_debit)
          • Transaction | Debit Internal SPEI (MX)
        • Credit
          • Transaction | Credit SPEI (MX)
          • Transaction | Credit FI (MX)
          • Transaction | Credit Internal SPEI (MX)
        • Transaction | Connect Obtain (MX)
        • Transaction | Cobre Balance Obtain (MX)
        • Transaction | Return SPEI (MX)
      • Transactions | Cobre Balance List All Items
      • Transaction | Adjustment Credit
      • Transaction | Adjustment Debit
      • Transaction | Credit Misc
      • Transaction | Debit Misc
    • Authentication
      • Authentication | Request
      • Authentication | Response
    • Cobre Keys
      • Colombia
        • Cobre Key | Create Request
        • Cobre Key | Create Response
        • Cobre Key | Obtain Response
        • Cobre Key | Reactive Request
    • Money Movements
      • Approvals
        • Money Movement Approvals | Create Request
        • Money Movement Approvals | Create Response
        • Money Movement Approvals | List All Items
      • Mexico
        • PayOut
          • Money Movement | Create Metadata Type SPEI
          • Money Movement | Response Metadata Type SPEI
        • Return
          • Money Movement Return | Create Request
          • Money Movement Return | Create Response
          • Money Movement Return | Response Medatada Type SPEI
        • PayIn
          • Money Movement Direct Link | Create Metadata Rail r2p SPEI
          • Money Movement Direct Link | Response Metadata Rail r2p SPEI
      • Colombia
        • PayOut
          • Money Movement | Create Metadata Type Fast Pay
          • Money Movement | Create Metadata Type Bre-B
          • Money Movement | Create Metadata Type ACH
          • Money Movement | Response Metadata Type ACH
          • Money Movement | Response Metadata Type Fast Pay
          • Money Movement | Response Metadata Type Bre-B
          • Money Movement | Response Metadata Type Bre-B Split
        • PayIn
          • Money Movement Direct Link | Create Metadata Rail PSE
          • Money Movement Direct Link | Create Metadata Rail r2p Breb
          • Money Movement Direct Link | Response Metadata Rail r2p Breb
          • Money Movement Direct Link | Response Metadata Rail PSE
          • Money Movement Direct Link | Response Metadata Rail Bancolombia
          • Money Movement Direct Link | Response Metadata Rail Nequi
        • Direct Debit
          • Money Movement Direct Debit | Create Metadata
          • Money Movement Direct Debit | Response Metadata
      • Global
        • Payout in stable
          • Money Movement | Create Metadata Type Global (stable)
          • Money Movement | Response Metadata Type Global (stable)
      • Money Movement | List All Items
      • Money Movement | Create Response
    • Accounts
      • Account Verification
        • Mexico
          • Account Verification Create Metadata Type mex_acc_details_1
          • Account Verification Response Metadata Type mex_acc_details_1
          • Account Verification Create Metadata Type mex_acc_ownership_1
          • Account Verification Response Metadata Type mex_acc_ownership_1
        • Colombia
          • Account Verification Response Metadata Type col_key_details_1
          • Account Verification Create Metadata Type col_key_details_1
          • Account Verification Create Metadata Type col_key_ownership_1
          • Account Verification Response Metadata Type col_key_ownership_1
          • Account Verification Create Metadata Type col_key_ownership_2
        • Account Verification Create Response
        • Account Verifications List All Items
      • Account References
        • Account References Request
        • Account Reference Response
        • List all account references
        • Account Reference Certificate Generation Response
      • Daily Balance
        • Daily Balance Historiy List All Items
        • Daily Balance Obtain Response
      • Cobre Balances and Connect Accounts
        • Mexico
          • Cobre Balance | Create Response (MX)
          • Connect Account | Response Metadata (MX)
          • Connect Account | Create Metadata (MX)
          • Cobre Balance | Create Metadata (MX)
        • Colombia
          • Cobre Balance | Create Response (CO)
          • Connect Account | Response Metadata (CO)
          • Connect Account | Create Metadata (CO)
          • Cobre Balance | Create Metadata (CO)
        • Global
          • Cobre Balance | Create Response (Global)
          • Cobre Balance | Create Metadata (Global)
        • Cobre Balance | Create Request
        • Connect Account | Create Request
        • Accounts | List All Items
        • Account | Update Request
    • Bulk Money Movement
      • Bulk Money Movement | Obtain Response
      • Bulk Money Movement Decision | Create Request
      • Bulk Money Movements | List All Items
    • Money Movement Scheduler
      • Money Movement Scheduler | Create Request
      • Money Movement Scheduler | Create Response
      • Money Movement Scheduler | List All Items
    • Checkout
      • Colombia
        • Checkout | Create Request
        • Checkout | Create Response
        • Checkout | List All Items
        • Checkout | Delete
    • Notifications
      • Subscription | Create Request
      • Subscription | Create Response
      • Subscription | List All Items
      • Subscribable Events | List All Items
      • Subscribable Events | Metadata
    • Evidence Request
      • Schemas
        • Error
        • Evidence Request
        • Document Type
        • Evidence Id
        • Upload Intent
        • Evidence Request Id
        • Evidence Request Status
        • Information Type
        • Information
        • Evidence
        • Information Status
        • Document
        • Document Status
        • Headers
      • RequestBodies
        • Upload Intent Request
    • Cross Border
      • Cross Border Money Movement
        • Cross Border Money Movement Create Request
        • Cross Border Money Movement Obtain Response
        • Cross Border Money Movements List All Items
        • Cross Border Money Movement Create Response
      • FX Quote
        • FX Static Quote
          • FX Quote Rolling | Create Response
          • FX Quote Rolling | Cross Border Response
        • FX Rolling Quote
          • FX Quote Static | Create Response
          • FX Quote Static | Cross Border Response
        • FX Quote | Create Request
        • FX Quote | List All Items
        • FX Quote | Metadata Fees Breakdown
        • FX Quote | Metadata Quote Tiers
        • FX Quote | Metadata Penalization Tier
    • Reports
      • Download
        • Report Download Create Request
        • Report Download Create Response
      • Reports Create Request
      • Reports Create Response
      • Reports Create Metadata
      • Reports List All Items
      • Cobre Balance Statement Request
      • Cobre Balance Statement Response
    • Error Model
      • Error Model
    • Report Scheduler
      • Report Schedulers | Create Request
      • Report Schedulers | Delete Response
    • Alerts
      • Create Alert
      • Alert Object
      • List All Alerts
      • Alert | Metadata Type fx_rate
  1. API 指南

快速入门

欢迎踏上与 Cobre 的精彩旅程！Cobre 是一个覆盖多个地区的资金流转平台。
Cobre 平台通过 API 提供支付产品。这些产品可通过简洁的接口端点访问，为客户提供无缝的支付功能。Cobre 处理支付处理的所有复杂环节，使客户从繁琐的资金流转运营中解脱出来。
立即联系我们的业务拓展团队，开启您访问 Cobre 平台的旅程。我们期待与您连接，共同开启这段非凡之旅！

API 安全#

Cobre 将安全性的易用与可及放在首位。获取和使用我们的 API 密钥的流程设计简洁直观，确保您从一开始就能安全地与我们的平台集成并运营。所有 API 请求均须通过稳健的 HTTPS 协议发起。这一承诺不仅为您的所有交易建立了安全环境，还能轻松防范过时 HTTP 请求所带来的安全漏洞。使用 Cobre，您将以最轻松的方式享受顶级安全保障。

日期与日期时间（UTC）：掌握时区#

Cobre 在平台内所有日期和日期时间字段中统一采用 UTC 时区，提供一致的时间体验。无论客户身处何地，交易和操作的时间均保持一致与同步。

示例#

UTC 时间戳："2023-07-15T12:00:00Z"
在 哥伦比亚（UTC-5），该时间戳对应 2023 年 7 月 15 日上午 7:00。
在 墨西哥城（标准时间 UTC-6），该时间戳对应 2023 年 7 月 15 日上午 6:00。
UTC 时间戳："2023-11-10T18:30:00Z"
在 哥伦比亚（UTC-5），该时间戳对应 2023 年 11 月 10 日下午 1:30。
在 墨西哥城（标准时间 UTC-6），该时间戳对应 2023 年 11 月 10 日下午 12:30 或 1:30，具体取决于夏令时安排。
通过与 UTC 对齐，Cobre 确保所有客户无论身处何地，均可无缝管理和解读日期与时间数据，从而提升全球业务运营的可靠性与效率。

分页详情#

了解 API 响应的结构是高效导航和使用 Cobre 平台的关键。以下是我们分页系统的说明：
total_items（数字）：API 返回的项目总数。
total_pages（数字）：按当前页面大小划分的总页数。
is_last_page（布尔值）：指示当前页是否为最后一页的真/假标识。默认值：false。
page_items（数字）：当前页的项目数量。默认值：50。
page_size（数字）：可设置每页的最大项目数量。
page_number（数字）：可选择指定页码。
contents（数组）：包含当前页所有项目的数组。
借助这些分页参数，客户可以方便地管理和遍历 API 提供的数据，确保与 Cobre 平台的集成顺畅高效。
请注意，分页最多支持 10,000 条记录。

性能准则与速率限制注意事项#

Cobre 公共 API 在稳定运行状态下支持每秒 20 笔交易（TPS）。为确保稳定的性能并避免因超时或过载导致 HTTP 429（请求过多）错误，我们强烈建议遵循 API 最佳实践，包括：
1.
实现指数退避重试逻辑。
2.
对敏感操作使用幂等性密钥。
3.
避免频繁轮询。
4.
优化请求频率。
5.
尽可能使用 Webhook 进行异步更新。
高效使用 API 有助于在流量高峰期保持低延迟、更高可靠性和可预测的行为。

API 规范#

幂等性#

资金流转及跨境资金流转的 POST 请求需要在请求头中携带 idempotency 字段，以防止重试时产生重复操作。若收到相同的密钥，Cobre 将返回原始响应而不重新执行操作。
规则详情
必填场景/v1/money_movements、/v1/cross_border_money_movements
请求方法POST
最小长度9 个字符
缺少请求头返回 HTTP 400

金额#

Cobre API 中的所有货币金额均以该货币的最小单位（辅币单位）表示。
货币最小单位金额API 值
COP分$1.500,20 COP150020
MXN分$2.390,15 MXN239015
USD分$1.52 USD152
此规则统一适用于所有接口端点——资金流转、余额、交易及 FX 报价。
Modified at 2026-05-20 21:31:19
Previous
订阅管理
Next
Authentication
Built with