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 指南

Authentication

Cobre 的 身份认证 API 专为客户与 Cobre 进行交互而设计,提供最佳、最安全且无摩擦的身份认证能力,从而便于访问 Cobre Move Money 平台。该 API 采用简洁直接的方式简化了身份认证流程,仅需提供 user_id 和 secret 即可完成认证。这些凭证在 Cobre 生态系统内获取,可确保安全高效的认证通道。

Cobre 身份认证 API 指南#

Cobre 身份认证 API 支持在 Cobre 资金流转平台内进行安全交互。请按照以下分步指南完成身份认证并有效使用平台服务。
1
Obtain API Credentials
在进行身份认证之前,您需要获取必要的 API 凭证:user_id 和 secret。这些凭证由 Cobre 生态系统提供,确保以安全便捷的方式访问平台。
2
Authenticate into the Platform
获取 API 凭证后,使用凭证登录平台完成身份认证。向身份认证 API 接口端点发送请求,并附上您的 user_id 和 secret。认证成功后,API 将返回一个 JSON Web Token(JWT)。
认证请求示例:
POST /auth
Content-Type: application/json

{
  "user_id": "your_user_id",
  "secret": "your_secret"
}
认证响应示例:
{
    "access_token": "eyJhbGciOiJSUzI1...",
    "type": "Bearer",
    "expiration_time": 1200
}
3
Start moving money!
持有 JWT 令牌后,您即可发起所有资金流转操作!

如何开始#

在开始之前,我们建议您先了解使用本方案所需的前置步骤。

使用此 API 前的准备#

在门户中创建 API 凭证#

进入门户,在左侧菜单底部找到 Developers 板块。
进入 Developers 板块后,点击 API 凭证选项卡,然后点击 + Create Credential。
系统将弹出新窗口。请为凭证设置别名并选择角色,以创建具有相应访问权限的 API 凭证。
凭证生成后,请务必将其妥善保存,因为之后将无法再次获取。

使用此 API 后的预期结果#

1
Start calling Cobre APIs
请参阅后续章节,进一步了解 Cobre 各 API。
2
Handle the token expiration

令牌管理与缓存:#

请勿在每次业务 API 调用时都请求新令牌。这种方式效率低下,可能导致因频率限制而被封锁。
获取 access_token 后对其进行缓存。
在调用业务 API 之前,检查缓存的令牌是否已过期。建议在令牌过期前稍早一些(例如提前 3 分钟)请求新令牌,以避免因过期导致的调用失败。

令牌生命周期管理的重要性#

Cobre API 使用 短期访问令牌,因此您的集成方案必须以可控方式处理令牌刷新:
请勿在每次 API 调用时都请求新令牌
应 缓存令牌 并重复使用,仅在令牌 临近过期 时刷新
实现一个统一的 "令牌管理器",供所有 Cobre API 请求共享
这将带来以下优势:
降低延迟(减少认证调用次数)
提升吞吐量稳定性
简化错误处理与可观测性
增强高负载下的系统韧性

推荐策略#

1)缓存令牌及其过期时间戳#
请求令牌时,响应中将包含:
一个 访问令牌
过期时长(通常为 expires_in)
您的集成方案应计算并存储以下内容:
token
expires_at = now + expires_in
条件允许时,请将令牌存储在内存中(速度最快)。
若您运行多个实例,建议使用共享缓存(如 Redis、Memcached),使所有副本复用同一令牌。

2)通过安全窗口实现 "及时刷新"#
无需等到令牌过期,而是提前刷新。
推荐安全窗口: 若令牌将在未来 60–120 秒 内过期,则触发刷新。
这可确保:
慢速请求期间令牌不会过期
避免因时钟偏差导致的边界情况
在高并发场景下不会出现大量 401 错误

3)确保同一时刻仅执行一次刷新(避免令牌风暴)#
若您的系统存在并行请求,必须避免 多个令牌刷新同时进行(通常称为 "令牌风暴")。
请使用锁 / 互斥量确保每次只有一个刷新操作执行,其余请求等待刷新完成。

参考实现(语言无关的伪代码)#

在每次向 Cobre 发起请求 之前 执行以下逻辑:
function getValidToken():
  if cached_token exists AND now < cached_expires_at - safety_window:
      return cached_token

  lock(token_refresh_lock):
      # Double-check after acquiring lock
      if cached_token exists AND now < cached_expires_at - safety_window:
          return cached_token

      response = requestNewToken()
      cached_token = response.access_token
      cached_expires_at = now + response.expires_in
      return cached_token

了解我们的身份认证 API 技术文档:
Authentication API
获取身份认证令牌,开始使用 Cobre API
Modified at 2026-05-20 21:31:19
Previous
快速入门
Next
管理虚拟余额账户(Cobre Balances)
Built with