Checkout
All user-facing screens—including payment method selection, payment instructions, confirmation, and success messages—are fully hosted and managed by Cobre. The integrator is only responsible for redirecting the user to the Checkout URL and handling post-payment logic through Webhooks.
Supported payment methods
| Payment Method | Rail | Interaction Type |
|---|---|---|
| PSE | pse | Hosted Checkout (Payment Link) |
| Bancolombia | bancolombia | Hosted Checkout (Payment Link) |
| Nequi | nequi | Hosted Checkout (Push Notification) |
| BreB QR | breb_qr | Hosted Checkout (QR Code) |
| BreB Key | breb_key | Hosted Checkout (Key) |
For PSE payments, the email defined in the counterparty is used to authenticate the user in the PSE flow. For Nequi payments, the phone number defined in the counterparty is used to send the push notification.
Checkout Customization
| Customizable Experience | Description | Field |
|---|---|---|
| Choose the Checkout name | Specify a clear, descriptive title (e.g. "My company") so customers instantly know what they’re paying for. | checkout_header |
| Open or Fixed product description | Decide if you want to set a predefined product item description or allow the payer to add their own custom reference. (e.g., “Monthly Membership” or “Donation to XYZ”) | checkout_item |
| Open or Fixed Amount | Decide whether the amount is locked in or open for the payer to specify. For example, set a fixed price for a product or allow a pay-what-you-want. | amount |
| Re-usables Links | Determine if your checkout link should be single-use or reusable (fixed or unlimited intents). | money_movement_intent_limit |
| Set an expiration date | Control the availability of your checkout link by setting an expiration date. Once this date is reached, the link becomes invalid. | valid_until |
| Choose Payment Rails | Select which payment methods (e.g., Nequi, PSE, Bancolombia, BreB) to include in your checkout. | checkout_rail |
For open-links with no expiration and/or open-links with no intents limit and/or open-amount value and/or open-item value, please use -1
| Customizable Item | Description | Field |
|---|---|---|
| External ID | An external reference or tracking ID that is passed through to the money movement. | external_id |
| Description to Payee | The payment description that appears on the transaction recorded in your Cobre balance . | description_to_payee |
| Redirect URL | The URL to which the client is redirected once the payment link is paid. | redirect_url |
Allowed Checkout combinations
| Geography | Source Type | Destination Type | Rails |
|---|---|---|---|
| COL | r2p | cobre_balance | PSE, Bancolombia, Nequi, BreB |
| COL | r2p_breb | cobre_balance | BreB |
Checkout lifecycle
1.
Creating a counterparty with the payer’s information is optional when using Checkout.
If the counterparty is not created beforehand, Checkout will collect all the required payer information during the hosted flow and automatically create the corresponding
r2p counterparty.2.
Create a Checkout by specifying the following parameters:
counterparty_id from the previous step as the source_id (optional)account_id where you want to receive the funds as the destination_idcheckout_railscheckout_header and checkout_itemamount expressed in the smallest unit of the currency (e.g., 100.00 MXN must be sent as 10000)valid_untilredirect_url where the payer will be redirected after Cobre displays the confirmation screenmoney_movement_intent_limit, which defines how many Money Movements can be created using the same Checkout Link3.
Once the Checkout is created, Cobre returns a
checkout_url that represents the hosted payment experience.4.
Redirect the payer to the
checkout_url to complete the payment.5.
The payer selects a payment method and completes the transaction within the Cobre-hosted Checkout. Once the payment is initiated, Checkout creates a Money Movement that allows tracking the payment status and its subsequent state changes.
6.
The Money Movement status changes are communicated via Webhooks.
7.
Once the payment is successful, funds are credited to the associated Cobre Balance.
The Money Movement generated by Checkout will include the checkout_idin thebatch_idfield. This allows you to correlate and reconcile the payment with the Checkout that initiated the transaction.
Actions performed on a Checkout
🔑 Create
🔍 Retrieval
❌ Desactivate
Description: Checkout Creation.
What to expect after the action: Checkout is created in Cobre.
📘 Learn more:
What to expect after the action: Checkout is created in Cobre.
📘 Learn more:
Checkout Idempotency
How to Get Started
Before using this API
You need a Cobre Balance in Colombia
To be able to receive money, you must have a Cobre Balance account in Colombia.
Create the Counterparty (Optional)
Before creating a Money Movement, you must create the Counterparty with the information of the payer.
Define the Checkout configuration
Decide which payment methods will be available, along with the amount, valid until date, and reference to be shown to the payer.
Implement Webhooks to track payment status
To stay informed about the status of Payin transactions, we strongly recommend implementing Webhooks. Webhooks notify your system when a payment is initiated, processed, completed, or failed. Also subscribe to the required events to receive notifications about transaction credits.See Notifications for more details.
What to expect after using this API
Redirect the user to Checkout
Redirect the payer to the
checkout_url returned when the Checkout is created.End user completes the payment
The payer completes the payment using the hosted Checkout interface.
Receive funds in your Cobre Balance
Once the payment is successful, funds are credited to your Cobre Balance and a Money Movement is updated.
Modified at 2026-01-06 02:30:54