1. Cobre Balances
  • Cobre Docs
    • Cobre Intro
      • Welcome
      • Get started
      • Products
        • Local Payments
          • Local Payments with Cobre
          • Payouts
            • Colombia
              • Money Movements with Bre-B
              • Money Movements with Cobre Fast Pay
            • Mexico
              • Money Movements with CLABEs and SPEI Cards
            • Multi-region
              • Money Movements Scheduler
          • Payins
            • Colombia
              • Checkout
              • Request to Pay (R2P)
              • Static Bre-B Keys
            • México
              • CLABE-backed Cobre Balances
              • Account Reference – Virtual CLABEs
          • Other feaures
            • Bulk Money Movements
            • Enabling Approval Workflows (Maker–Checker)
        • Cross Border Payments
          • Cross Border Payments with Cobre
        • Stablecoins
          • Global Payouts in Stablecoins
        • Connect
          • Connect bank accounts with Cobre
      • Other features
        • Account Verification
        • Notifications and subcriptions
        • Security at Cobre
        • Performance and throughput
    • Portal
      • Introduction & Quick Start
      • Authentication in Portal
      • Troubleshooting & Support
      • Movements
        • Local Money Movement
        • Unitary Payment Initiation
        • Bulk Money Movement Initiation
        • Approval Process (Maker-Checker)
        • Scheduler
        • Cross-Border Money Movements
        • Payment Links
      • Transactions
        • Transactions
      • Accounts
        • Account and Balance Management
      • Counterparties
        • Counterparties
      • Reports
        • Reports & Reconciliation
      • Settings
        • Users and Roles Management
        • Security and Control
      • Developers
        • Subscription management
    • Developers
      • API Guides
        • Quick Start
        • Authentication
        • Cobre Balances
          • Managing Cobre Balances
          • Account Linkeage
        • Connect Accounts
          • Managing Connect Accounts
        • Counterparties
          • Managing Counterparties
        • Local Payments
          • Money Movement
          • Payouts
            • Colombia
              • Fast Pay & ACH
              • Bre-B
            • Mexico
              • SPEI
            • Cross-Region
              • Bulk Money Movements
              • Bulk Money Movements Approval
              • Money Movement Scheduler
          • Payins
            • Colombia
              • Cobre Keys with Bre-B
              • Checkout
              • Direct Link
              • Direct Debit
            • Mexico
              • Account Reference – Virtual CLABEs
        • Cross Border Payments
          • Cross Border Payments
          • Create Fx Quotes
          • Create a Cross Boder Money Movement
          • Fund your global Cobre Balance
        • Cross Features
          • Reports
          • Report Scheduler
          • Evidence API
          • Account Verification
          • Notifications & Subscriptions
        • Error Handling
          • Error Dictionary
        • Testing
          • General Testing
          • Testing Cases
      • API Explorer
        • Authentication API
          • Authentication
        • Cobre Balances
          • Create a Cobre Balance
          • Obtain all Accounts
          • Obtain one Account
          • Update an Account
          • Close a Cobre Balance
          • Obtain one Account Transactions
          • Obtain one Transaction
          • Obtain all Client Transactions
          • Obtain Account Daily Balance History
          • Assign or Change Primary Account
          • Unlinking Primary Account
        • Connect Accounts
          • Connect an Account
          • Obtain one Connected Account
          • Obtain all Connected Accounts
          • Obtain one Transaction
          • Obtain all Account Transactions
          • Obtain all Client Transactions
          • Update an account
        • Account Verifications
          • Create an Account Verification
          • Obtail all Account Verifications
        • Account References
          • Create an Account Reference
          • List one Account Reference
          • List all Account References
          • Delete an Account References
        • Counterparties
          • Account Debit Registration
            • Register a Counterparty for Direct Debit
            • Obtain all Registrations
            • Obtain one Registration
          • Create a Counterparty
          • Obtain one Counterparty
          • Obtain all Counterparties
          • Delete a Counterparty
        • Money Movements
          • Create a Money Movement
          • Obtain one Money Movement
          • Obtain all Money Movements
          • Return a Money Movement
        • Money movement Approvals
          • Approve a Money Movement
          • List all Money Movement Approvals
        • Money Movement Scheduler
          • Create a Money Movement Scheduler
          • List all Money Movement Schedulers
          • Cancel an Active Scheduler
        • Bulk Money Movement
          • Create a Bulk Money Movement
          • List all Bulk Money Movements
          • List one Bulk Money Movement
        • Bulk Money Movement Approvals
          • Bulk Money Movements Decision
        • Cobre Keys
          • Create a Key
          • Obtain all Keys
          • Obtain one Key
          • Cancel a Key
          • Block or Reactivate Keys
        • Cross Border
          • Create a FX Quote
          • Obtain one FX Quote
          • Obtain all the FX Quotes
          • Create a Cross Border Money Movement
          • Obtain one Cross Border Money Movement
          • Obtain all the Cross Border Money Movements
        • Checkout
          • Create a Checkout
          • Obtain one Checkout
          • Obtain all Checkouts
          • Desactivate a Checkout
        • Evidence API
          • Evidence Requests
            • Obtain Evidence Request
            • Search Evidence Requests
          • Evidence Documents
            • Generate Upload Links
            • Generate Download Link
          • Evidence Information
            • Submit Evidence Information
        • Report Scheduler
          • Create a Report Scheduler
          • Obtain all Reports Schedulers
          • Delete a Report Scheduler
        • Reports
          • Create a Report
          • Obtain all Reports
          • Generate Download Link for Selected Reports
          • Create a Cobre Balance Statement
        • Notifications & Subscriptions
          • Subscribe to Events
          • Obtain all Subcriptions
          • Delete a Subscription
          • List all Available Events
      • Platform Catalogs
        • Mexican Bank Codes
        • Colombian Bank Codes
        • Transaction Types
        • Account Providers
      • Reports Layout
        • Money Movements Layout
          • All Money Movements (CSV)
          • All Money Movements (JSON)
          • SPEI Money Movements (CSV)
          • LEGACY Money Movements (CSV)
        • Transactions Layout
          • All Transactions (CSV)
          • All Transactions (JSON)
          • Cobre Balance Statement (PDF)
        • Counterparties Layout
          • All Counterparties (CSV)
        • Multicash Layout
          • Multicash Header (TXT)
          • Multicash Detail (TXT)
      • Testing APIs
        • Create a Transaction Adjustment
        • Change a Money Movement Status
        • Transaction Adjustment (QA)
        • Change Money Movement Status (QA)
    • Schemas
      • Counterparties
        • RequestBodies
          • Counterparty-request
        • Colombia
          • PayOut
            • Counterparty | Create Metadata Type CC (CO)
            • Counterparty | Response Metadata Type CC (CO)
            • Counterparty | Create Metadata Type CH (CO)
            • Counterparty | Response Metadata Type CH (CO)
            • Counterparty | Create Metadata Type DP (CO)
            • Counterparty | Response Metadata Type DP (CO)
            • Counterparty | Create Metadata Type Breb Key (CO)
            • Counterparty | Response Metadata Type Breb Key (CO)
            • Counterparty | Create Metadata Type Cobre Balance (CO)
            • Counterparty | Response Metadata Type Cobre Balance (CO)
          • PayIn
            • Counterparty | Create Metadata Type r2p (CO)
            • Counterparty | Response Metadata Type r2p (CO)
            • Counterparty | Create Metadata Type r2p Breb (CO)
            • Counterparty | Response Metadata Type r2p Breb (CO)
          • Secondary Counterparty
            • Secondary Counterparty Create Request (CO)
            • Secondary Counterparty Create Response (CO)
            • Secondary Counterparty Create Metadata Type NP (CO)
            • Secondary Counterparty Response Metadata Type NP (CO)
            • Secondary Counterparty Request Metadata Type LE
            • Secondary Counterparty Response Metadata Type LE (CO)
          • Direct Debit
            • Direct Debit Registration | Create
            • 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 | Response Metadata Type Clabe (MX)
            • Counterparty | Create Metadata Type SPEI Card (MX)
            • Counterparty | Response Metadata Type SPEI Card (MX)
          • Counterparty | Create Request (MX)
          • Counterparty | Create Response (MX)
        • Global
        • Counterparty | List All Items
        • MEX Money Movement Return
      • Transactions
        • Global
          • Transaction | Debit Cross Border
          • Transaction | Credit 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 Breb (CO) (breb_credit)
            • Transaction | Credit r2p (r2p_credit)
            • Transaction | Credit r2p Breb (CO) (r2p_breb_credit)
          • Transaction | Connect Obtain (CO)
          • Transaction | Cobre Balance Obtain (CO)
        • Mexico
          • Debit
            • Transaction | Debit FI (MX) (mex_debit)
            • Transaction | Debit SPEI (MX) (spei_debit)
            • Transaction | Debit Internal SPEI (MX)
          • Credit
            • Transaction | Credit FI (MX)
            • Transaction | Credit SPEI (MX)
            • Transaction | Credit Internal SPEI (MX)
          • Transaction | Connect Obtain (MX)
          • Transaction | Cobre Balance Obtain (MX)
          • Transaction | Return SPEI (MX)
        • Transactions | Connect List All Items
        • Transactions | Cobre Balance List All Items
        • Transaction | Debit Misc
        • Transaction | Credit Misc
        • Transaction | Adjustment Debit
        • Transaction | Adjustment Credit
      • 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 | Response Medatada Type SPEI
            • Money Movement Return | Create Response
        • Colombia
          • PayOut
            • Money Movement | Create Metadata Type Fast Pay
            • Money Movement | Response Metadata Type Fast Pay
            • Money Movement | Create Metadata Type ACH
            • Money Movement | Response Metadata Type ACH
            • Money Movement | Create Metadata Type Breb
            • Money Movement | Response Metadata Type ACH
          • PayIn
            • Money Movement Direct Link | Create Metadata Rail PSE
            • Money Movement Direct Link | Response Metadata Rail PSE
            • Money Movement Direct Link | Response Metadata Rail Bancolombia
            • Money Movement Direct Link | Response Metadata Rail Nequi
            • Money Movement Direct Link | Create Metadata Rail r2p Breb
            • Money Movement Direct Link | Response Metadata Rail r2p Breb
          • Direct Debit
            • Money Movement Direct Debit | Create Metadata
            • Money Movement Direct Debit | Response Metadata
        • Money Movement | Create Response
        • Money Movement | List All Items
      • 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 Request
            • Account Verification Create Response
            • Account Verification Create Metadata Type mex_acc_ownership_1
            • Account Verification Response Metadata Type mex_acc_ownership_1
            • Account Verifications List All Items
          • 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 References
          • Account References Request
          • Account Reference Response
          • List all account references
        • Cobre Balances
          • Mexico
            • Cobre Balance | Create Metadata (MX)
            • Cobre Balance | Create Response (MX)
          • Colombia
            • Cobre Balance | Create Metadata (CO)
            • Cobre Balance | Create Response (CO)
          • Global
            • Cobre Balance | Create Metadata (Global)
            • Cobre Balance | Create Response (Global)
          • Cobre Balance | Create Request
          • Cobre Balances | List All Items
          • Account_request_PATCH
          • Account_request_CONNECT_PATCH
        • Daily Balance
          • Daily Balance Obtain Response
          • Daily Balance Historiy List All Items
        • Account Connect
          • Mexico
            • Account Conect | Create Metadata (MX)
            • Account Connect | Response Metadata (MX)
          • Colombia
            • Account Conect | Create Metadata (CO)
            • Account Connect | Response Metadata (CO)
          • Account Connect | Create Request
          • Accounts Connect | List All Items
      • 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
          • UploadIntentRequest
      • Cross Border
        • Cross Border Money Movement
          • Cross Border Money Movement Create Request
          • Cross Border Money Movement Create Response
          • Cross Border Money Movement Obtain Response
          • Cross Border Money Movements List All Items
        • FX Quote
          • FX Static Quote
            • FX Quote Static | Create Request
            • FX Quote Static | Create Response
          • FX Rolling Quote
            • FX Quote Rolling | Create Request
            • FX Quote Rolling | Create 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
        • Reportes Create Metadata
        • Request Body Reports
        • Reports List All Items
        • Reports Object
      • Error Model
        • Error-model
      • Report Scheduler
        • Report Schedulers | Create Request
        • Report Schedulers | Create Response
  1. Cobre Balances

Managing Cobre Balances

The Cobre Balances APIs provides services to set up, maintain, and manage Cobre Balance accounts. For this purpose a set of different APIs and endpoints will be exposed so that by using the provided services clients can register accounts and obtain all the previously registered accounts and their corresponding information.
A delete endpoint is available so that accounts can be closed from Cobre’s platform for some providers.

Creating Cobre Balances#

The platform enables the creation of "Cobre Balances" across its operational regions, through the Create a Cobre Balance API. These accounts are fundamental for accessing a range of platform services, depending on the geography. Cobre Balances serve as a versatile asset within the Cobre environment, enhancing financial flexibility.

Cobre Balance Providers Catalog#

For effective use of Create a Cobre Balance API, a provider ID is required along with the specification of an action. This ensures the API can accurately process your request.
Only the action create within the accounts API is available for Cobre Balance providers.
Colombia Balances
Mexico Balances
Global Balances
The following list contains all the available Cobre Balance providers in Colombia, along with their available services. These accounts are fundamental for accessing a range of platform services, including faster Payments.
CodeSupplierCreateBalancesTransactionsPayments
pr_col_cobreCobre Balance ColombiaYesYesYesYes

Actions performed on a Cobre Balance#

🔑 Create
🔍 Retrieval
✍️ Update
🪢 Account Linkage
⛓️‍💥 Account Unlinkage
❌ Close
Description: Cobre Balance Creation.
What to expect after the action: Cobre Balance in state Created.
📘 Learn more: 🔗 Create a Cobre Balance

Cobre Balance transactions#

🔍 Retrival
🗂️ Daily Balance History
Description: 🔎 Get all transactions related to all Cobre Balances, or to a specific Cobre Balance. Also get transactions realated to to a specific Cobre Balance.
What to expect after the action: List of transaction information (i.e. debits and credits) or a specific transaction information.
📘 Learn more:
Obtain all client transactions
Obtain account transactions
Obtain one transaction

How to Get Started#

Before you begin, we recommend having clarity on the preliminary steps required before using this solution.

Before using this API#

1
When creating a Cobre Balance, use the right provider_id according to the region and currency required
Use the right provider based on the region or currency required. See the above section Cobre Balance Providers Catalog for more details.
2
Think on the number of Cobre Balances you need
Decide if having one or multiple Cobre Balances will help you with managing payments information. For instance, it is possible to define one Cobre Balance per Merchant for an E-Commerce Platform so that every merchant related transactions can be tracked independently on each correspoding Cobre Balance.
3
Decide if linking a Primary account makes sense for your use case
Cobre Balances with a Primary Account set, will automatically sweep any credit transaction to that Primary Account. This is useful for Collections uses cases where receving funds in independent Cobre Balances makes sense, but all the funds must be aggregated later in a single Cobre Balance or local account.
See Account Linkeage for more details.
4
Subscribe to transaction notifications
Subscribe to transaction notifications to receive information about:
Transaction credits (e.g., accounts.balance.credit)
Transaction debits (e.g., accounts.balance.debit)
See Notifications & Suscriptions for more details

What to expect after using this API#

1
Start moving money
Send money
to local accounts - see Local Payouts guides in Colombia and Mexico
to other Cobre Balances - use another Cobre Balance as destination
to stablecoin wallets in ETH, Tron, Solana, Polygon, Base, and XRPL from Global Cobre Balances in USD
in bulk operations to local accounts - see Bulk Money Movements guide
in scheduled sweeps from multiple Cobre Balances to a Cobre Balance or to a local account - see Money Movement Scheduler guide
Receive money
from Bre-B, PSE, Nequi, Nequi Direct Debit, and Bancolombia Button in Colombia - see Checkout guide and Direct Link guide
from SPEI with Virtual CLABEs in Mexico - see Virtual CLABEs guide
from stablecoin hot wallets in ETH/Polygon and Tron to USD Global Balances
2
Get Cobre Balances transaction information on demand
Use the Cobre Balance transactions endpoints specified in the corresponding section in this guide to get the debits and credits that affected the Cobre Balance.
3
Track debits and credits on a Cobre Balance
Receive the webhook notifications for every credit and debit transaction on a Cobre Balance when exists an active suscription to accounts.balance.credit and accounts.balance.debit event types.
See Notifications & Suscriptions
4
Assign Bre-B keys to Colombian Cobre Balances
Assign static Bre-B keys that can be shared to receive money in a Cobre Balance.
See Cobre Keys guide
5
Convert between currencies
Convert currencies in real-time to support Cross Border transfer use cases
See Cross Border Payments
Modified at 2026-01-09 01:34:37
Previous
Authentication
Next
Account Linkeage
Built with