Use cases
Pick the right collection or transfer configuration for your business scenario.
Bre-B Participant gives you a small set of fields that, combined, cover most ways a business receives or sends money. A use case is a recommended combination of those fields for a concrete scenario — a one-off product purchase, a subscription, a donation, a supplier payout. This section turns "what do I configure for X?" into a recipe you can copy.
There is no special "subscription" or "donation" endpoint. You always create a collection (to receive) or an outgoing transfer (to send); the configuration you choose is what makes it behave like a subscription or a donation.
Every field used here is part of the live API. The recipes name the fields and their effect — for the full request and response, follow the API-reference link on each page.
The decisions that define a collection
When you receive money (Recaudo), four choices shape the behavior:
- How many times can it be paid?
usage_modeissingle_use(accepts one successful payment, then closes) ormultiple_use(keeps accepting payments until a cap is reached, or forever). - How much, in total?
total_maximum_amountandtotal_minimum_amountbound the lifetime of the collection. Set them equal for a fixed price; omit both to let it stay open indefinitely. - How much per payment?
minimum_attempt_amountandmaximum_attempt_amountbound each individual payment — useful for installments and top-ups. - How is it shared? A dynamic QR carries a fixed amount and a short expiry (one checkout). A static QR has no amount and can be printed or posted for many payers.
Two optional fields brand the payment: custom_key_value (a readable suffix on the payment key, e.g. @MN{random}REFOREST) and custom_merchant_name (the name the payer sees).
The decisions that define an outgoing transfer
When you send money (Dispersiones), the choices are about the recipient and trust:
- Who receives it? Provide a
query.value(a payment key Mono resolves for you) or a pre-resolvedtarget_id. - Do you need to confirm identity first?
expected_creditormakes Mono fail the transfer if the resolved recipient doesn't match who you expected — essential for refunds. - One or many? A single request can carry one transfer or a batch of many, each tracked independently.
Pick your rail
Collection use cases (Recaudo)
Product purchase, shopping cart, subscription, donation, installments, invoice, flash sale, gift card, variable debt, marketplace split.
Outgoing transfer use cases (Dispersiones)
Seller payment, refund with identity check, batch payouts, pre-resolution, mixed-result batches, every key type, error handling.
Next steps
- Collections concept — the entity these recipes configure.
- Collection states — how
ready → minimum_paid → paidworks. - Sandbox: collections — try a recipe end to end without a real bank.