1. API Guides
🇺🇸 English
  • 🇺🇸 English
  • 🇪🇸 Español
  • 🇨🇳 中文(简体)
  • Cobre Intro
    • Welcome
    • Get started
    • Connect Cobre's Documentation to AI
    • 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
          • United States
            • Money Movements with Fedwire
          • Multi-region
            • Money Movements Scheduler
        • Payins
          • Colombia
            • Checkout
            • Request to Pay (R2P)
            • Direct Debit with Nequi
            • Static Bre-B Keys
            • Transfer-In
          • México
            • Request to Pay (R2P)
            • CLABE-backed Virtual Balances Accounts (Cobre Balances)
            • Virtual CLABEs
          • United States
            • Fedwire Payins at Cobre
        • Other feaures
          • Bulk Money Movements
          • Enabling Approval Workflows (Maker–Checker)
          • Named Accounts in Mexico
      • Cross Border Payments
        • Cross Border Payments with Cobre
      • Connect
        • Connect bank accounts with Cobre
    • Other features
      • Account Verification
      • Notifications and subscriptions
      • Security at Cobre
      • Performance and throughput
    • Using Cobre
      • Bre-B Payouts with Payment Instruments of Your Ecosystem
      • Cobre for Lenders
      • Integrating Cobre from ERPs
  • Portal
    • Introduction & Quick Start
    • Authentication in Portal
    • Troubleshooting & Support
    • Movements
      • Approval Process (Maker-Checker)
      • Local Money Movement
      • Unitary Payment Initiation
      • Bulk Money Movement Initiation
      • Cross-Border Money Movements
      • Scheduler
      • Payment Links
    • Transactions
      • Transactions
    • Accounts
      • Account and Balance Management
      • Account References
        • Virtual CLABEs
        • Transfer Accounts (Transfer-In)
    • 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 Virtual Balance Accounts (Cobre Balances)
        • Account Linkeage
        • Named Accounts (MX)
      • Connect Accounts
        • Managing Connect Accounts
      • Counterparties
        • Managing Counterparties
      • Local Payments
        • Money Movement
        • Payouts
          • Colombia
            • Fast Pay & ACH
            • Bre-B
          • Mexico
            • SPEI
          • United States
            • Fedwire Payouts
          • Cross-Region
            • Money Movements Approval
            • Bulk Money Movements
            • Bulk Money Movements Approval
            • Money Movement Scheduler
        • Payins
          • Colombia
            • Cobre Keys with Bre-B
            • Checkout
            • Direct Link
            • Direct Debit
            • Transfer-In
            • Processing Refunds in Colombia
          • Mexico
            • Account Reference – Virtual CLABEs
            • Direct Link
            • Processing Refunds in Mexico
          • United States
            • Fedwire Payins
      • Cross Border Payments
        • Cross Border Payments
        • Create Fx Quotes
        • Create a Cross Boder Money Movement
        • Fund your global Cobre Balance
      • Cross Features
        • Account Verification
        • Reconciliation with Cobre Reports in Colombia
        • Reports
        • Report Scheduler
        • Evidence API
        • Notifications & Subscriptions
        • FX Alerts
      • Testing
        • General Testing
        • Testing Cases
        • Testing PSE and Bancolombia
      • Certification
        • Certification Process
        • Questionnaire
    • API Explorer
      • Build with AI
      • Authentication
        • Authentication
      • Accounts
        • Create or Connect an Account
        • Obtain all Accounts
        • Obtain one Account
        • Update an Account
        • Close a Cobre Balance
        • Obtain one Account Transactions
        • Obtain one Transaction
        • Obtain all Transactions
        • Obtain Account Daily Balance History
        • Assign or Change Primary Account
        • Unlinking Primary Account
      • Account Verifications
        • Create an Account Verification
        • Obtain one Account Verification
        • Obtain all Account Verifications
      • Account References
        • Create an Account Reference
        • List one Account Reference
        • List all Account References
        • Delete an Account Reference
        • Generate a Certificate for your Account Reference
      • Cobre Keys
        • Create a Key
        • Obtain all Keys
        • Obtain one Key
        • Cancel a Key
        • Block or Reactivate Keys
      • 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
      • 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
        • Evidence Requests
          • Obtain Evidence Request
          • Search Evidence Requests
        • Evidence Documents
          • Generate Upload Links
          • Generate Download Link
        • Evidence Information
          • Submit Evidence Information
      • Reports
        • Create a Report
        • Obtain all Reports
        • Generate Download Link for Selected Reports
        • Create a Cobre Balance Statement
      • Report Scheduler
        • Create a Report Scheduler
        • Obtain all Reports Schedulers
        • Delete a Report Scheduler
      • Notifications & Subscriptions
        • Subscribe to Events
        • Obtain all Subscriptions
        • Delete a Subscription
        • List all Available Events
      • Alerts
        • Create Alert
        • Obtain All Alerts
        • Obtain One Alert
        • Deactivate An Alert
      • Subclients
        • Create a Subclient
        • Obtain all Subclients
        • Obtain one Subclient
    • Platform Catalogs
      • Colombian Bank Codes
      • Mexican Bank Codes
      • Account Providers
      • Transaction Types
      • Money Movement Statuses
      • Error Dictionary
    • Testing APIs
      • Create a Transaction Adjustment
      • Change a Money Movement Status
      • Transaction Adjustment (QA)
      • Change Money Movement Status (QA)
    • 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)
        • Virtual Balance Account (Cobre Balance) Statement (PDF)
      • Counterparties Layout
        • All Counterparties (CSV)
      • Multicash Layout
        • Multicash Header (TXT)
        • Multicash Detail (TXT)
    • Notifications Layout
      • Account Events
        • Account Balance Credit
        • Account Balance Debit
      • Cobre Keys
        • Cobre Keys
      • Counterparties
        • Counterparties
        • Direct Debit Registration
      • Money Movement
        • Money Movement
      • Bulk Money Movement
        • Bulk Money Movement
      • Cross Border Money Movement
        • Cross Border Money Movement
      • Evidence Requests
        • Evidence Requests
      • Reports
        • Reports
      • Alerts
        • FX Alerts
      • Account References
        • Account References
      • Subclients
        • Subclients
  • Schemas
    • Counterparties
      • Colombia
        • PayOut
          • Counterparty | Create Metadata Type Cobre Balance (CO)
          • Counterparty | Response Metadata Type Cobre Balance (CO)
          • Counterparty | Create Metadata Type Breb Key (CO)
          • Counterparty | Response Metadata Type Breb Key (CO)
          • Counterparty | Create Metadata Type QR (CO)
          • Counterparty | Response Metadata Type QR (CO)
          • 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)
        • PayIn
          • Counterparty | Response Metadata Type r2p (CO)
          • Counterparty | Create Metadata Type r2p (CO)
          • Counterparty | Create Metadata Type r2p Breb (CO)
          • Counterparty | Response Metadata Type r2p Breb (CO)
        • Secondary Counterparty
          • Secondary Counterparty Create Request
          • 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)
        • PayIn
          • Counterparty | Create Metadata Type r2p (MX)
          • Counterparty | Response Metadata Type r2p (MX)
        • Counterparty | Create Response (MX)
        • Counterparty | Create Request (MX)
        • Counterparty | Money Movement Return (MX)
      • USA
        • Counterparty | Create Request (USA)
        • Counterparty | Create Response (USA)
        • Request Medatata Business
        • Response Medatata Business
        • Request Medatata Individual
        • Response Medatata Individual
        • Counterparty | Create Request (USA)
        • Counterparty | Create Response (USA)
      • Counterparty | List All Items
    • 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 r2p (r2p_credit)
          • Transaction | Credit Breb (CO) (breb_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
      • Transaction | Debit Misc
      • Transaction | Credit Misc
      • Transaction | Adjustment Debit
      • Transaction | Adjustment Credit
      • Transactions | Cobre Balance List All Items
    • 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
        • PayIn
          • Money Movement Direct Link | Create Metadata Rail r2p SPEI
          • Money Movement Direct Link | Response Metadata Rail r2p SPEI
      • Colombia
        • PayOut
          • Money Movement | Create Metadata Type Fast Pay
          • Money Movement | Response Metadata Type Bre-B
          • Money Movement | Create Metadata Type Bre-B
          • Money Movement | Response Metadata Type Fast Pay
          • Money Movement | Create Metadata Type ACH
          • Money Movement | Response Metadata Type ACH
          • Money Movement | Response Metadata Type Bre-B
          • Money Movement | Response Metadata Type Bre-B Split
        • PayIn
          • Money Movement Direct Link | Create Metadata Rail PSE
          • Money Movement Direct Link | Response Metadata Rail PSE
          • Money Movement Direct Link | Response Metadata Rail r2p Breb
          • Money Movement Direct Link | Create Metadata Rail r2p
          • 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
        • Direct Debit
          • Money Movement Direct Debit | Create Metadata
          • Money Movement Direct Debit | Response Metadata
      • United States
        • PayOut
          • Money Movement | Create Metadata Type Fedwire
          • Money Movement | Response Metadata Type Fedwire
        • PayOuts
      • Money Movement | List All Items
      • Money Movement | Create Response
    • 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 Metadata Type mex_acc_ownership_1
          • Account Verification Response Metadata Type mex_acc_ownership_1
        • 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 Verificacion Response Metadata Type col__key_ownership_2
          • Account Verification Create Metadata Type col_key_ownership_2
        • Account Verification Create Response
        • Account Verifications List All Items
      • Account References
        • Account References Request
        • Account Reference Response
        • List all account references
        • Account Reference Certificate Generation Response
      • Daily Balance
        • Daily Balance Obtain Response
        • Daily Balance Historiy List All Items
      • Cobre Balances and Connect Accounts
        • Mexico
          • Cobre Balance | Create Metadata (MX)
          • Connect Account | Create Metadata (MX)
          • Connect Account | Response Metadata (MX)
          • Cobre Balance | Create Response (MX)
        • Colombia
          • Cobre Balance | Create Metadata (CO)
          • Cobre Balance | Create Response (CO)
          • Connect Account | Create Metadata (CO)
          • Connect Account | Response Metadata (CO)
        • USA
          • Cobre Balance | Create Metadata (USA)
          • Cobre Balance | Create Response (USA)
        • Cobre Balance | Create Request
        • Connect Account | Create Request
        • Accounts | List All Items
        • Account | Update Request
    • 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
        • Upload Intent Request
    • 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 Rolling Quote
          • FX Quote Static | Create Response
          • FX Quote Static | Cross Border Response
        • FX Static Quote
          • FX Quote Rolling | Create Response
          • FX Quote Rolling | Cross Border 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
      • Reports Create Metadata
      • Reports List All Items
      • Cobre Balance Statement Request
      • Cobre Balance Statement Response
    • Error Model
      • Error Model
    • Report Scheduler
      • Report Schedulers | Create Request
      • Report Schedulers | Delete Response
    • Alerts
      • Create Alert
      • Alert Object
      • List All Alerts
      • Alert | Metadata Type fx_rate
    • Subclients
      • create_subclients_mexico
  1. API Guides

Quick Start

Welcome to the thrilling journey with Cobre, the Money Movement platform available across various geographies!
Cobre Platform offers payments products through APIs. These products are accessible via straightforward endpoints, enabling clients with seamless payment functionalities. Cobre handles all the complexities of payment processing, freeing clients from the intricacies of money movement operations.
Connect with our Business Development team today to unlock your access to Cobre Platform. We're eager to connect with you and start this remarkable journey together!

API Security#

At Cobre, we prioritize making security seamless and accessible. Obtaining and using our API keys is designed to be straightforward, ensuring you can securely integrate and operate with our platform from the get-go. Every API request is required to be made through the robust HTTPS protocol. This commitment not only establishes a secure environment for all your transactions but also effortlessly safeguards against the vulnerabilities of outdated HTTP requests. With Cobre, you experience the pinnacle of security with the utmost ease.
Cobre strongly advise to consider taking the following security measures when integrating our APIs:
• Store API credentials in a secure location - e.g., a vault (e.g., Hashicorp Vault, CyberArk, AWS Secrets Manager)
• Rotate API secrets frequently (Recommendation - once a month)
• Configure API Whitelisting on both sides (Client and Cobre)
Cobre IPs: 50.17.12.196, 54.173.144.191
To configure Client IPs, a ticket must be sent to soporte@cobre.co
• Configure Secure Key for Webhooks
• Separate the Dev/Test and Production environments to segregate access - Cobre offers independent environments to facilitate this separation.

Dates and Datetimes (UTC): Mastering Time Zones#

Cobre utilizes the universal UTC timezone for all date and datetime fields within our platform, offering a unified experience of time. This approach ensures that irrespective of where our clients are based, the timing of transactions and operations remains consistent and synchronized.

Examples#

UTC Timestamp: "2023-07-15T12:00:00Z"
In Colombia (UTC-5), this timestamp translates to July 15th, 2023, at 7:00 AM.
In Mexico City (UTC-6 during Standard Time), this represents July 15th, 2023, at 6:00 AM.
UTC Timestamp: "2023-11-10T18:30:00Z"
In Colombia (UTC-5), this corresponds to November 10th, 2023, at 1:30 PM.
In Mexico City (UTC-6 during Standard Time), this means November 10th, 2023, at 12:30 PM or 1:30 PM depending on the daylight saving schedule.
By aligning with UTC, Cobre ensures that all clients, regardless of their geographic location, can seamlessly manage and interpret date and time data, enhancing the reliability and efficiency of global operations.

Pagination Details#

Understanding the structure of our API responses is key to navigating and utilizing the Cobre Platform effectively. Here's a breakdown of our pagination system:
total_items (number): The total number of items returned by the API.
total_pages (number): The number of pages given the current page size.
is_last_page (boolean): A true/false indicator showing whether the current page is the last page. Default: false.
page_items (number): The number of items in the current page. Default: 50.
page_size (number): You can set the maximum number of items in a page.
page_number (number): You can select the page.
contents (array): An array containing the items of the current page.
With these pagination parameters, clients can easily manage and traverse through the data provided by our APIs, ensuring a smooth and efficient integration with the Cobre Platform.
Keep in mind that it is not possible to paginate more than 10,000 records.

Performance Guidelines: Rate and Burst Limit Considerations#

Rate Limit#

Cobre's public API supports 30 transactions per second (TPS) under steady-state operation. To ensure consistent performance and avoid HTTP 429 (Too Many Requests) errors, we strongly recommend following these API best practices:
Implement exponential backoff with retry logic.
Use idempotency keys on all sensitive operations.
Avoid aggressive polling patterns.
Optimize request frequency and batching where applicable.
Rely on Webhooks for asynchronous updates whenever possible.
Efficient API usage helps maintain low latency, high reliability, and predictable behavior — even under peak traffic conditions.

Burst Limit#

In addition to the sustained rate limit, each client's API key has a burst limit of 200 requests, implemented using a token bucket algorithm. This bucket holds up to 200 tokens (one per request) and refills at a rate of 30 tokens per second — matching the steady-state rate limit.
This means:
That 200-request allowance is a one-time buffer, not a repeatable per-second cap. Once consumed, it only refills at 30 tokens/second, so sustained traffic above 30 TPS will deplete the bucket and eventually trigger HTTP 429 responses.
For example: if you fire 100 requests in the first second while the bucket is full, all 100 succeed and the bucket refills by 30 (now at 130/200). But if you sustain 50 requests/second continuously, the 200-token buffer depletes within roughly a few seconds, after which excess requests are throttled to the 30 TPS refill rate until your request volume normalizes.
Important: Because all credentials under a single client share one underlying API key, creating multiple credentials (e.g., for different services or use cases) does not increase available throughput.
To avoid burst-related throttling, we recommend:
Smoothing request distribution — spread requests evenly over time rather than sending them in large batches.
Implementing a token bucket or leaky bucket algorithm on your side — these patterns naturally absorb bursts while respecting rate boundaries.
Monitoring 429 responses proactively — treat them as a signal to back off immediately and retry with exponential delay.
Avoiding synchronized retries — if multiple processes retry simultaneously after a failure, it can amplify the burst. Add jitter to retry intervals.

API Conventions#

Idempotency#

Money movement and Cross Border Money Movement POST requests require an idempotency header to prevent duplicate operations on retry. If the same key is received again, Cobre returns the original response without re-executing the operation.
RuleDetail
Required on/v1/money_movements, /v1/cross_border_money_movements
MethodPOST
Minimum length9 characters
Missing headerReturns HTTP 400

Amounts#

All monetary amounts in Cobre's API are expressed in the smallest unit of the currency (minor units).
CurrencySmallest unitAmountAPI Value
COPcents$1.500,20 COP150020
MXNcents$2.390,15 MXN239015
USDcents$1.52 USD152
This applies consistently across all endpoints — money movements, balances, transactions, and FX quotes.
Modified at 2026-07-01 14:23:50
Previous
Subscription management
Next
Authentication
Built with