Skip to main content
BRE-B payouts deliver Colombian pesos to a verified BRE-B key. The user completes KYC before COP By prepares the deposit transaction.

​
Requirements

  • Minimum payout: 4,000 COP.
  • Minimum sent to Bridge: 2 USDC.
  • Supported source tokens: USDC and COPm.
  • Use a real user wallet and an idempotency key for payout creation.

​
1. Verify the customer

Send and verify an email OTP. If the customer is not already approved, continue through the KYC and terms links returned by the API. Do not create a payout until the KYC status is approved.

​
2. Quote the payout

Call GET /api/integrations/breb/quote with destinationCop and fromToken. The quote includes the effective rate, source amount, expiration, and fee stack.

​
3. Create and review

Call POST /api/integrations/breb/payouts with the destination key and account owner name. COP By verifies that the destination details match before returning the transaction.
Stop when the API returns destination_mismatch. Do not ask the user to send funds to an unverified destination.

​
4. Sign and confirm

The user signs the returned deposit transaction. Submit its unique transaction hash to POST /api/integrations/breb/payouts/{payoutId}/confirm.

​
5. Track delivery

Read the payout endpoint or consume signed partner webhooks. Treat webhooks as notifications and the payout resource as the source of truth during reconciliation.
Local development can use BRIDGE_MOCK=true. The default mock OTP is 123456; mock mode must not be used to represent a production payout.

Webhooks

Verify signatures, deduplicate events, and handle retries.

API reference

Inspect every KYC, quote, payout, and confirmation endpoint.