Bre-B

使用 Bre-B Key 和 Bre-B QR 的出款解决方案提供从 Cobre Balance 或银行账户向在哥伦比亚注册了 Bre-B Key 的收款方汇转资金的服务，采用 Bre-B 即时支付通道。

Bre-B 出款通常用于通过基于密钥的目标地址即时发送资金，无需共享传统银行账户信息，从而实现快速且用户友好的出款体验。

Bre-B 限制与路由行为

使用 Bre-B Key 和 Bre-B QR 通道的出款受到一定的操作限额约束。

通过 Bre-B 通道每笔交易允许的最高金额约为 COP 12,110,000。

如果出款金额超过 Bre-B 的最高限额，Cobre 将根据收款方所在银行及可用性，自动尝试通过 Fast Pay 或 ACH 路由该笔交易。此路由行为由 Cobre 内部处理，且仅适用于 Bre-B Key。

如果出款金额超过 Bre-B 的最高限额，且要求通过该通道处理，Cobre 可使用 Split Payments 将付款拆分为多笔交易。该功能须在提交付款时指定，且仅适用于 Bre-B keys。

在使用 Bre-B Keys 时，尤其是针对大额出款，我们建议提前验证预期交易金额。

支持的交易对手方

通过 Bre-B Key 和 Bre-B QR 的出款支持以下哥伦比亚目标类型：

目标类型	交易对手方类型	支付通道
Bre-B Key	`breb_key`	Bre-B / Fast Pay* / ACH*
Bre-B QR	`breb_qr`	Bre-B

（*）Fast Pay 或 ACH 仅在因 Bre-B 通道限制需要重新路由交易时使用。

授权工作流（可选）

Checker Approval 是一种可选方案，可在出款流程中使用。它在交易发送至支付网络之前触发授权工作流。在审批待处理期间，资金流动将保持 pending_approval 状态，直至被批准或拒绝。审批流程可通过 Cobre Portal 完成，也可通过 API 以编程方式完成。

出款生命周期

通过 Bre-B Key 的 PayOut 遵循简单的生命周期：

1. 创建 Bre-B Key 或 Bre-B QR 交易对手方（收款人）
使用收款人已注册的 Bre-B Key 信息创建类型为 breb_key 或 breb_qr 的交易对手方。
该交易对手方代表出款交易的目标地址。

2. 创建资金流动
创建资金流动时需使用以下信息：

用于扣款的账户 account_id，作为 source_id。

上一步中获得的 counterparty_id，作为 destination_id。

包含 description 的元数据。

external_id，可用于发送来自您系统的参考编号。

以货币最小单位表示的金额（例如，COP 100.00 应表示为 10000）。

Bre-B QR 出款

当交易对手方类型为 breb_qr 且二维码定义了不等于 -1 的 qr_amount 时，资金流动金额必须与之相同。

Bre-B Split Payments

要启用 Split Payments，须在元数据中包含 split 字段，并将其值设置为 true。

如需使用我们的授权流程，请将 checker_approval 设置为 true。

3. 资金流动处理中
创建后，资金流动初始状态为 initiated。

若所有验证通过，状态将变更为 processing。此时，交易通过 Bre-B 发送。

若在验证或处理过程中发生错误，资金流动将转为最终的 failed 状态。

若资金流动创建时设置了 checker_approval = true，它将首先进入 pending_approval 状态，并在做出审批决定后才会转为 processing 或 canceled。

4. 资金扣划
一旦资金流动转为 processing 状态，资金将从关联的 Cobre Balance 中扣划。

5. 等待资金流动的最终结果。

若资金流动状态为 completed，表示收款人已成功收到资金。

若资金流动状态为 rejected，资金将退回至您的 Cobre Balance。

6. 接收状态更新
资金流动状态变更通过 Webhook 进行通知。

对资金流动（出款）执行的操作

🔑 Create

🔍 Retrieval

说明： 创建资金流动。
执行该操作后的预期结果： 资金流动在 Cobre 中创建完成。
📘 了解更多：

🔗 创建资金流动

资金流动幂等性

资金流动创建支持幂等性。

幂等性密钥有效期为 24 小时。

如何开始

在开始之前，我们建议您查阅以下注意事项。

使用此 API 前

You need a Cobre Balance in Colombia

要使用 Bre-B 发送资金，您必须在哥伦比亚拥有一个有足够余额的有效 Cobre Balance 账户。

Create the beneficiary Counterparty

在创建出款资金流动之前，您必须根据所选目标类型创建包含收款人信息的交易对手方。

Define the Payout configuration

确定目标类型、金额以及处理出款所需的任何元数据。

Implement Webhooks to track payment status

为及时了解出款交易的状态，我们强烈建议实现 Webhook。Webhook 可在付款发起、处理中、完成或失败时通知您的系统。同时请订阅所需事件，以接收有关交易扣款和入账的通知。

详情请参阅通知与订阅。

使用此 API 后的预期结果

Initiate the Payout

资金流动创建请求发送后，将以 initiated 状态创建。
请确保您的系统已准备好在资金流动经历其生命周期时接收状态更新。

Track the transaction status

通过 Webhook 或查询接口监控出款生命周期。

Funds are delivered to the beneficiary

出款成功后，资金将入账至收款人账户，资金流动状态将相应更新。

Bre-B

Bre-B 限制与路由行为#

支持的交易对手方#

授权工作流（可选）#

出款生命周期#

对资金流动（出款）执行的操作#

资金流动幂等性#

如何开始#

使用此 API 前#

使用此 API 后的预期结果#

Bre-B 限制与路由行为

支持的交易对手方

授权工作流（可选）

出款生命周期

对资金流动（出款）执行的操作

资金流动幂等性

如何开始

使用此 API 前

使用此 API 后的预期结果