1. 通用功能
🇨🇳 中文(简体)
  • 🇺🇸 English
  • 🇪🇸 Español
  • 🇨🇳 中文(简体)
  • Cobre 简介
    • 欢迎
    • 快速入门
    • 将 Cobre 文档接入 AI
    • 产品
      • 本地支付
        • 使用 Cobre 进行本地支付
        • 收款
          • 哥伦比亚
            • 收银台
            • 请求支付
            • 通过 Nequi 进行直接扣款
            • 静态 Bre-B 密钥
            • 转入 (Transfer-In)
          • 墨西哥
            • 请求支付
            • 基于 CLABE 的虚拟余额账户
            • 虚拟 CLABEs
          • 美国
            • Fedwire 向 Cobre 付款
        • 出款
          • 哥伦比亚
            • 通过 Bre-B 进行资金流动
            • 通过 Cobre Fast Pay 进行资金流动
          • 墨西哥
            • 通过 CLABEs 和 SPEI 卡进行资金流动
          • 美国
            • 通过 Fedwire 进行资金流动
          • 多地区
            • 资金流动调度器
        • 其他功能
          • 批量资金流动
          • 启用审批工作流(双人复核)
      • 跨境支付
        • 通过 Cobre 进行跨境支付
      • 连接
        • 连接 Cobre 关联银行账户
      • 稳定币
        • 全球稳定币出款
    • 其他功能
      • 账户核验
      • 通知与订阅
      • Cobre 安全机制
      • 性能与吞吐量
    • 使用 Cobre
      • 使用您生态系统中的支付工具通过 Bre-B 进行出款
      • 面向贷款机构的 Cobre
      • 从 ERP 系统集成 Cobre
  • 网络门户
    • 简介与快速入门
    • 门户认证
    • 故障排查与支持
    • 资金流动
      • 审批流程(双人复核)
      • 本地资金流动
      • 单笔支付发起
      • 批量资金流动发起
      • 跨境资金流动
      • 支付链接
      • 调度程序
    • 交易
      • 交易
    • 账户
      • 账户与余额管理
      • 账户参考
        • 虚拟 CLABE
        • 转账账户(转入)
    • 交易对手方
      • 交易对手方
    • 报告
      • 报告与对账
    • 设置
      • 用户与角色管理
      • 安全与管控
    • 开发者
      • 订阅管理
  • 开发者
    • API 指南
      • 快速入门
      • 身份验证
      • Cobre Balances
        • 管理虚拟余额账户(Cobre Balances)
        • 账户关联
      • Connect 账户
        • 管理 Connect 账户
      • 交易对手方
        • 管理交易对手方
      • Local Payments
        • 资金流动
        • 出款
          • 哥伦比亚
            • Fast Pay & ACH
            • Bre-B
          • 墨西哥
            • SPEI
          • 跨地区
            • 批量资金流动审批
            • 资金流动调度器
            • 批量资金流动
          • 美国
            • 通过 Fedwire 付款
          • 全球
            • 稳定币全球出款
        • 收款
          • 哥伦比亚
            • Cobre Keys 与 Bre-B 集成
            • 收银台
            • Direct Link
            • Direct Debit
            • Transfer-In
            • 在哥伦比亚处理退款
          • 墨西哥
            • 账户参考 – 虚拟 CLABE
            • Direct Link
            • 在墨西哥处理退款
          • 美国
            • 通过 Fedwire 收款
      • 跨境支付
        • 跨境支付
        • 创建 FX 报价
        • 创建跨境资金流动
        • 为全球 Cobre Balance 注入资金
      • 通用功能
        • 账户核验
        • 使用 Cobre Reports 在哥伦比亚进行对账
        • 报告
        • 报告调度器
        • 证据 API
        • 通知与订阅
        • FX 汇率预警
      • 错误处理
        • 错误字典
      • 测试
        • 通用测试
        • 测试用例
        • 测试 PSE 与 Bancolombia
      • 认证
        • 认证流程
        • 问卷
    • API 浏览器
      • 借助 AI 进行开发
      • 身份验证 API
        • 身份验证
      • 账户
        • 创建或关联账户
        • 获取所有账户
        • 获取单个账户
        • 更新账户
        • 关闭 Cobre Balance
        • 查询单个账户的交易记录
        • 获取单笔交易
        • 获取所有交易记录
        • 获取账户每日余额历史记录
        • 分配或更换主账户
        • 解除主账户关联
      • 账户核验
        • 创建账户核验
        • 获取单条账户核验记录
        • 获取所有账户核验记录
      • 账户参考
        • 创建账户参考
        • 查询单个账户参考
        • 查询所有账户参考
        • 删除账户参考
        • 为账户参考生成证书
      • Cobre 密钥
        • 创建密钥
        • 获取所有 Keys
        • 获取单个 Key
        • 注销 Key
        • 封禁或重新激活 Keys
      • 交易对手方
        • 账户借记注册
          • 为 Direct Debit 注册交易对手方
          • 获取所有注册记录
          • 获取单条注册记录
        • 创建 Counterparty
        • 获取单个 Counterparty
        • 获取所有 Counterparties
        • 删除交易对手方
      • 资金流动
        • 创建资金流动
        • 查询单笔资金流动
        • 查询所有资金流动
        • 退回资金流动
      • 批量资金流动审批
        • 批量资金流动审批决策
      • 资金流动调度器
        • 创建资金流动调度器
        • 获取所有资金流动调度器列表
        • 取消活跃的调度器
      • 批量资金流动
        • 创建批量资金流动
        • 列出所有批量资金流动
        • 查询单条批量资金流动
      • 资金流动审批
        • 审批资金流动
        • 列出所有资金流动审批
      • 跨境支付
        • 创建 FX 报价
        • 获取单条 FX 报价
        • 获取全部 FX 报价
        • 创建跨境资金流动
        • 获取单条跨境资金流动
        • 获取所有跨境资金流动记录
      • 收银台
        • 创建 Checkout
        • 获取单个 Checkout
        • 获取所有 Checkout
        • 停用 Checkout
      • 证据 API
        • 证据请求
          • 获取证据请求
          • 搜索证据请求
        • 证据文件
          • 生成上传链接
          • 生成下载链接
        • 证据信息
          • 提交证据信息
      • 报告
        • 创建报告
        • 获取所有报告
        • 为所选报告生成下载链接
        • 创建 Cobre Balance 对账单
      • 报告调度器
        • 创建 Report Scheduler
        • 获取所有 Report Schedulers
        • 删除 Report Scheduler
      • 通知与订阅
        • 订阅事件
        • 获取所有订阅
        • 删除订阅
        • 列出所有可用事件
      • 预警
        • 创建预警
        • 获取所有预警
        • 获取单个预警
        • 停用告警
    • 平台目录
      • 墨西哥银行代码
      • 账户提供方
      • 交易类型
      • 资金流动状态
      • 哥伦比亚银行代码
    • API 测试
      • 创建交易调整
      • 更改资金流动状态
      • 交易调整(QA)
      • 变更资金流动状态(QA)
    • 报告布局
      • 资金流动布局
        • 所有资金流动 (CSV)
        • 所有资金流动 (JSON)
        • SPEI 资金流动 (CSV)
        • LEGACY 资金流动 (CSV)
      • 交易布局
        • 所有交易 (CSV)
        • 所有交易 (JSON)
        • 虚拟余额账户 (Cobre Balance) 对账单 (PDF)
      • 交易对手方布局
        • 所有交易对手方 (CSV)
      • Multicash 布局
        • Multicash 表头 (TXT)
        • Multicash 明细 (TXT)
    • 通知布局
      • 账户事件
        • 账户余额借记
        • 账户余额贷记
      • Cobre 密钥
        • Cobre 钥匙
      • 交易对手方
        • 交易对手方
      • 资金流动
        • 资金流动
      • 批量资金流动
        • 批量资金流动
      • 跨境资金流动
        • 跨境资金流动
      • 证据请求
        • 证据请求
      • 报告
        • 报告
      • 预警
        • FX 预警
      • 账户参考
        • 账户参考
  • Schemas
    • Counterparties
      • Colombia
        • PayOut
          • Counterparty | Create Metadata Type CC (CO)
          • Counterparty | Create Metadata Type CH (CO)
          • Counterparty | Create Metadata Type DP (CO)
          • Counterparty | Create Metadata Type Breb Key (CO)
          • Counterparty | Create Metadata Type Cobre Balance (CO)
          • Counterparty | Create Metadata Type QR (CO)
          • Counterparty | Response Metadata Type CC (CO)
          • Counterparty | Response Metadata Type CH (CO)
          • Counterparty | Response Metadata Type DP (CO)
          • Counterparty | Response Metadata Type Breb Key (CO)
          • Counterparty | Response Metadata Type Cobre Balance (CO)
          • Counterparty | Response Metadata Type QR (CO)
        • PayIn
          • Counterparty | Create Metadata Type r2p (CO)
          • Counterparty | Create Metadata Type r2p Breb (CO)
          • Counterparty | Response Metadata Type r2p (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 | Response Metadata Type Clabe (MX)
          • Counterparty | Response Metadata Type SPEI Card (MX)
          • Counterparty | Create Metadata Type Clabe (MX)
          • Counterparty | Create Metadata Type SPEI Card (MX)
        • PayIn
          • Counterparty | Response Metadata Type r2p (MX)
          • Counterparty | Create Metadata Type r2p (MX)
        • Counterparty | Create Response (MX)
        • Counterparty | Create Request (MX)
        • Counterparty | Money Movement Return (MX)
      • Global
        • Counterparty | Global CP Request
        • Counterparty | Global CP Response
        • Counterparty | Global Deposit NP request
        • Counterparty | Global Deposit LE request
        • Counterparty | Global Deposit NP response
        • Counterparty | Global Deposit LE response
      • USA
        • Counterparty | Create Request (USA)
        • Counterparty | Create Response (USA)
        • Request Medatata Business
        • Request Medatata Individual
        • Response Medatata Business
        • 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 FI (CO) (col_credit)
          • Transaction | Credit Cobre Balance (CO) (col_cb_credit)
          • Transaction | Credit r2p (r2p_credit)
          • Transaction | Credit Direct Debit (CO) (dd_credit)
          • Transaction | Rejected Breb (breb_rejected)
          • Transaction | Credit Breb (CO) (breb_credit)
          • Transaction | Credit r2p Breb (CO) (r2p_breb_credit)
          • Transaction | Credit Top Up (CO) (col_top_up_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)
      • United States
        • PayOuts
          • Money Movement | Create Metadata Type Fedwire
          • Money Movement | Response Metadata Type Fedwire
      • Money Movement | List All Items
      • Money Movement | Create Response
    • Accounts
      • Account Verification
        • Mexico
          • Account Verification Create Metadata Type mex_acc_details_1
          • Account Verification Create Metadata Type mex_acc_ownership_1
          • Account Verification Response Metadata Type mex_acc_ownership_1
          • Account Verification Response Metadata Type mex_acc_details_1
        • Colombia
          • Account Verification Create Metadata Type col_key_details_1
          • Account Verification Create Metadata Type col_key_ownership_1
          • Account Verification Create Metadata Type col_key_ownership_2
          • Account Verification Response Metadata Type col_key_ownership_1
          • Account Verification Response Metadata Type col_key_details_1
        • 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)
          • Cobre Balance | Create Metadata (MX)
          • Connect Account | Create Metadata (MX)
        • Colombia
          • Cobre Balance | Create Response (CO)
          • Connect Account | Response Metadata (CO)
          • Cobre Balance | Create Metadata (CO)
          • Connect Account | 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 Quote Tiers
        • FX Quote | Metadata Penalization Tier
        • FX Quote | Metadata Fees Breakdown
    • Reports
      • Download
        • Report Download Create Request
        • Report Download Create Response
      • Reports Create Request
      • Reports Create Response
      • Reports List All Items
      • Cobre Balance Statement Request
      • Cobre Balance Statement Response
      • Reports Create Metadata
    • 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. 通用功能

通知与订阅

Cobre 的通知与订阅 API 提供了一种集中式机制,用于订阅平台事件并通过 Webhook 接收实时更新。该服务使客户能够及时了解跨多项功能(包括账户、资金流动、跨境操作、批量操作、报告、证据请求及 Cobre Keys)所发生的运营与财务变动。
通知采用标准化事件 Schema 进行推送,确保所有已订阅事件保持一致性。通过此 API,客户可订阅特定事件类型、管理其订阅,并可选择启用签名通知,以验证所接收事件的完整性与真实性。

创建订阅#

订阅通过 创建订阅 API(POST /v1/subscriptions)创建。该接口端点允许客户指定:
希望订阅的 事件
通知将被推送到的 目标 URL(Webhook)
用于内部参考的可选 描述
用于启用签名通知的可选 event_signature_key
订阅创建完成后,每当已订阅事件发生时,Cobre 将开始推送 Webhook 通知。

可订阅事件目录#

以下目录列出了 所有可订阅事件,按服务和功能分组。
创建订阅时请使用 Subscription Key。
Accounts Events
Cobre Keys Events
Counterparties Events
Money Movements Events
Bulk Money Movements Events
Cross-Border Money Movements Events
Evidence Requests Events
FX Rate Alerts Events
Reports Events
Account References Events

签名通知#

签名通知通过允许客户验证所接收事件的真实性与完整性,提供额外一层安全保障。
如需启用签名通知,请在创建订阅时包含 event_signature_key 参数。
API 响应中返回的 event_signature_key 将被脱敏处理,仅最后 4 位字符可见。

签名通知请求头#

event-timestamp:事件创建时间戳(UTC)
event-signature:使用事件载荷与签名密钥生成的 HMAC-SHA256 哈希值

验证通知签名#

步骤一:拼接时间戳与请求体#

event-timestamp + "." + raw_body
请求体必须 不含空格或换行符 发送。

正确拼接示例:#

event-timestamp:2025-02-03T22:20:24Z
body:
{
   "id": "ev_BdES3CkhSVmz0rqGfWXs",
   "event_key": "accounts.balance.credit",
   "created_at": "2025-02-03T22:20:24Z",
   "content": {
     "id": "trx_SUrdrNG67vb8cztFdeA0",
     "type": "internal_credit",
     "amount": 1,
     "currency": "COP",
     "date": "2025-02-03T22:20:23.677Z",
     "metadata": {
       "uniqueTransactionId": "mm_9zPfIqJZAepjeR",
       "sender_account_number": "@coraa00233",
       "description": "BMM Unitary test",
       "sender_name": "Product Alpha",
       "tracking_key": "",
       "sender_id": "9011830296"
     },
     "account_id": "acc_rLR7UkxEt4",
     "previous_balance": 40460,
     "current_balance": 40461,
     "credit_debit_type": "credit"
   }
 }

拼接后的字符串:#


2025-02-03T22:20:24Z.{"id":"ev_BdES3CkhSVmz0rqGfWXs","event_key":"accounts.balance.credit","created_at":"2025-02-03T22:20:24Z","content":{"id":"trx_SUrdrNG67vb8cztFdeA0","type":"internal_credit","amount":1,"currency":"COP","date":"2025-02-03T22:20:23.677Z","metadata":{"uniqueTransactionId":"mm_9zPfIqJZAepjeR","sender_account_number":"@coraa00233","description":"BMM Unitary test","sender_name":"Product Alpha","tracking_key":"","sender_id":"9011830296"},"account_id":"acc_rLR7UkxEt4","previous_balance":40460,"current_balance":40461,"credit_debit_type":"credit"}}

步骤 2:生成哈希值#

算法:HMAC-SHA256
密钥:event_signature_key
编码:UTF-8
生成的哈希值必须与 event-signature 请求头中接收到的值一致。

正确哈希计算示例:#

使用上述拼接字符串,并采用以下 event_signature_key 来复现哈希计算过程:
event_signature_key:

"cobre is super secure" 

计算结果哈希值#


1ff93b74902d1f94c38d0cf384a6b44d294b4557b3bfa8cb79c6dce9ba467215
请注意,计算所得的哈希值与 文档顶部请求头 event-signature 字段中发送的哈希值 完全一致。
在哈希计算过程中,您可能需要指定输入内容及 HMAC 的编码方式。在此类情况下,请使用 UTF-8 编码。

通知重试机制#

重试次数适用错误类型触发条件重试间隔
自动重试 3 次仅限连接错误4xx 响应不触发重试200ms、400ms、1000ms

通知与订阅相关操作#

🔑 Create
🔍 Retrieval
📋 List Events
❌ Delete
说明: 创建对一个或多个事件的订阅,并定义 Webhook URL。
执行该操作后的预期结果:
返回一个订阅对象,包含以下字段:
id
events
url
created_at
📘 了解更多: 🔗 创建订阅

Webhook 通知数据结构#

{
  "id": "ev_xxxxx",
  "event_key": "accounts.balance.credit",
  "created_at": "2025-02-03T22:20:24Z",
  "content": {
    // Event-specific payload
  }
}

如何开始使用#

1
Expose a secure webhook endpoint
确保您已具备一个支持接收 POST 请求并处理 JSON 载荷的 HTTPS 接口端点。
2
Identify the required events
查阅可订阅事件目录,选择所有相关事件。
3
Create a subscription
使用创建订阅 API 注册您的 Webhook URL 及所选事件。
4
Implement signature verification
启用签名通知,并对收到的事件进行验签以确保其真实性。
5
Handle retries and idempotency
设计 Webhook 逻辑,以安全地处理重复或重试的事件,保证幂等性。

使用此 API 后的预期结果#

1
Real-time operational visibility
实时获取所有已订阅平台功能的状态更新。
2
Event-driven automation
触发内部工作流,例如对账、告警及监控。
3
Reliable and secure delivery
签名通知与重试机制共同保障事件的完整性与可靠投递。
4
Scalable integrations
在 Cobre 平台之上构建可扩展的事件驱动架构。
Modified at 2026-06-12 23:18:07
Previous
证据 API
Next
FX 汇率预警
Built with