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

Account Linkeage

Account Linkage allows you to associate (or link) any pair of accounts so that automatic movements are triggered when a credit is posted.

Understanding primary and secondary accounts#

A primary account is any account, Cobre Balance, or counterparty where the funds will automatically be redirected to. This account will receive automatic funds from a secondary account. You will need to declare it when creating a Cobre Balance
A primary account can have multiple secondary accounts
A secondary account is the Cobre Balance that is configured to automatically move funds to a primary account
A secondary account can only be associated with one primary account

Valid combinations#

The following combinations are allowed when linking an account
Colombia
Mexico
Secondary accountSecondary allowed typeSecondary allowed providerPrimary accountPrimary allowed typePrimary allowed providerMM FlowMM type generated
account_idcobre_balancepr_col_cobrecounterparty_id or account_idchecking (cc), saving (ch), electronic deposit (dp), or Cobre BalanceAnyPUSHACH, fast_pay or Bre-B
Cobre Balance counterparties are not allowed as primary accounts

Money Movement Flow for Linkage Accounts#

After linking a primary account to a secondary account, the following funds flow will occur:
1.
Transaction Reception: A transaction is received on the secondary account, which will be reflected as a credit transaction.
2.
Money Movement Processing: The secondary account will initiate a Money Movement to the primary account. This money movement will include the transaction_id of the initial credit transaction. If succesful, the following transactions will be posted:
2.1. A transaction debit will be posted in the secondary account.
2.2. A transaction credit will be posted in the primary account.
image.png
Keep in mind: If the automatic money movement to the primary account fails, the funds will remain in the secondary account and must be managed manually by the client

Allowed Actions on Account Linkage#

🔗 Configure linked accounts
✍️ Assign or change primary accounts
⛓️‍💥 Unlink primary account
Description: When creating a Cobre Balance account and a primary account is set in the matadata section, the link with the primary account is automatically generated.
What to expect after the action: Funds received in the Cobre Balance account will be redirected to the primary account associated during the Cobre Balance creation.
📘 Learn more: 🔗 Create a Cobre Balance

How to Get Started#

To create linked accounts, you must associate a primary account to a secondary account. This can be done by declaring it within the metadata upon account creation

Before using this API#

1
Select a primary account with a valid provider
This is the Cobre Balance or Counterparty that will automatically receive the funds credited to the Cobre Balance linking it.
2
Configure, change, or unlink a primary account for the first time
Create a new Cobre Balance whose primary account is the Cobre Balance or Counterparty designated for such purpose.
3
Subscribe to transaction notifications
Subscribe to the required events to receive notifications about transaction credits or money movement status, such as accounts.balance.credit or money_movements.status.completed

What to expect after using this API#

1
Transaction Reception
When transaction is received on the secondary account (e.g., PSE payment in Colombia or a SPEI transfer in Mexico), it will be reflected as a credit transaction (i.e., col_credit in Colombia, spei_credit in Mexico)
2
Money Movement Processing
After the transaction reception, the secondary account will initiate a Money Movement to the primary account. This money movement will include the transaction_id of the initial credit transaction (i.e., external_id = transaction_id).
2.1 Debit Transaction Posting
A debit transaction will be posted in the secondary account once the money movement is processed. (i.e., col_cb_debit in Colombia Cobre Balances, spei_debit in Mexico Cobre Balances)
2.2 Credit Transaction Posting
A credit transaction will be posted in the primary account reflecting the transfer of funds. (i.e., col_cb_credit in Colombia Cobre Balances, spei_credit in Mexico Cobre Balances)
Keep in mind that if the action to be performed is unlink, steps 2, 2.1, and 2.2 will not longer be executed, and the funds will remain in the secondary account.
Modified at 2026-01-09 01:35:43
Previous
Managing Cobre Balances
Next
Managing Connect Accounts
Built with