Bre-B

通过 Bre-B Key 和 Bre-B QR 的 Payout 解决方案，可将资金从 Cobre Balance 或银行账户发送至在哥伦比亚已注册 Bre-B Key 的收款方，使用 Bre-B 即时支付通道。

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

Bre-B 限制与路由行为

使用 Bre-B Key 和 Bre-B QR 通道的 Payouts 受一定运营限额的约束。

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

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

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

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

支持的交易对手方

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

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

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

授权工作流（可选）

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

Payout 生命周期

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

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

2. 创建资金流动
创建资金流动时使用：

资金将从中扣款的账户的 account_id，作为 source_id。

上一步骤中的 counterparty_id 作为 destination_id。

包含 description 的 metadata。

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

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

Bre-B QR Payouts

当交易对手方类型为 breb_qr 且 QR 码具有不同于 -1 的已定义 qr_amount 时，资金流动的金额必须与其一致。

Bre-B Split Payments

要启用 Split Payments，必须在 metadata 中包含 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. 接收状态更新
资金流动状态变更通过 Webhooks 进行通知。

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

🔑 Create

🔍 Retrieval

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

🔗 创建资金流动

资金流动幂等性

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

幂等键有效期为 24 小时。

如何开始

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

使用此 API 前

You need a Cobre Balance in Colombia

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

Create the beneficiary Counterparty

在创建 Payout 资金流动之前，您必须使用收款人信息创建一个交易对手方，并与所选目标类型匹配。

Define the Payout configuration

确定目标类型、金额以及处理 Payout 所需的任何 metadata。

Implement Webhooks to track payment status

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

详情请参阅通知与订阅。

使用此 API 后的预期结果

Initiate the Payout

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

Track the transaction status

通过 Webhooks 或查询接口监控 Payout 生命周期。

Funds are delivered to the beneficiary

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

Bre-B

Bre-B 限制与路由行为#

支持的交易对手方#

授权工作流（可选）#

Payout 生命周期#

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

资金流动幂等性#

如何开始#

使用此 API 前#

使用此 API 后的预期结果#

Bre-B 限制与路由行为

支持的交易对手方

授权工作流（可选）

Payout 生命周期

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

资金流动幂等性

如何开始

使用此 API 前

使用此 API 后的预期结果