Cobre's Platform exposes its payments products through a set of APIs. These products are accessible via straightforward endpoints, giving clients seamless payment functionality without the operational overhead. Cobre handles the complexities of payment processing, freeing clients from the intricacies of money movement operations.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.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.
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.| Rule | Detail |
|---|
| Required on | /v1/money_movements, /v1/cross_border_money_movements |
| Method | POST |
| Minimum length | 9 characters |
| Missing header | Returns HTTP 400 |
Amounts#
All monetary amounts in Cobre's API are expressed in the smallest unit of the currency (minor units).| Currency | Smallest unit | Amount | API Value |
|---|
| COP | cents | $1.500,20 COP | 150020 |
| MXN | cents | $2.390,15 MXN | 239015 |
| USD | cents | $1.52 USD | 152 |
This applies consistently across all endpoints — money movements, balances, transactions, and FX quotes.Although the API documentation represents amount as an integer, the field is handled internally as int64, supporting values up to 9,223,372,036,854,775,807