Operational Models

Overview

The Passport PaaS platform supports multiple merchant hierarchy models to accommodate various commercial and operational structures. This document describes the three common models used by organizations and their customers: Merchant Brand Mode, Semi-centralized, and Aggregator.

Supported Merchant Models

Merchant Branch Mode

In this model, merchants have the flexibility to select either a single account or individual accounts for each of their sub-merchants. For instance, as illustrated below, a merchant may operate under a main brand while managing each branch distinctly, with each location linked to its own dedicated merchant account. This approach allows for tailored financial management and reporting, ensuring that each branch can operate autonomously while still being part of the overarching brand.

Decentralized Model Diagram

Example: Decentralized Model

Each merchant branch is onboarded as a separate entity.
Each has its own Merchant Account and settlement flow.
Useful when each location operates independently and requires autonomy in reporting, reconciliation, and operations.

Implementation Notes

Create a merchant entity per location using the Create Customer endpoint.
Link a dedicated merchant account using Link Account.
Create the Bre-B to be linked to the account and the QR Codes for in-store or online purchases.
Webhooks can be configured per account for real-time notifications (coming soon).

Semi-decentralized (Platform-Managed) Model

The platform provider, such as a payment gateway, is empowered to access and manage merchant accounts across multiple branches or different customers.

Semi-decentralized Model Diagram

Example: Semi-decentralized Model

Platform provider manages the merchant accounts on behalf of a customer or several.

Implementation Notes:

Platform provider uses its credentials to onboard merchants or sub-merchants..
Merchant accounts are still created per branch.
Webhooks can be configured per account for real-time notifications (coming soon).
Create a merchant entity using the Create Customer endpoint.
Create the Bre-B to be linked to the account(s) and the QR Codes for in-store or online purchases.
Link a dedicated merchant account using Link Account.

Aggregator Model

A single merchant entity, such as a payment gateway (Aggregator), is responsible for managing multiple payment accounts internally. While only one customer entity is created with its own profile, the system allows for the creation of one or more merchant accounts.

Aggregator Model Diagram

Example: Aggregator Model

A single merchant entity, referred to as an Aggregator, manages multiple payment accounts within its internal structure.
Often used by marketplaces or super-apps.

Implementation Notes:

Only one customer entity is created (its own profile).
One or more merchant accounts can be created.

Implication on User Experience

In the Bre-B model, when initiating a payment by the customer or the end-user making a payment to your customer, one critical step is the Key Resolution, which is performed automatically by the Passport PaaS platform.

This process returns the details of the account owner (check the breb_resolved_key object below):

JSON
    
 
{
    "breb_resolved_key": {
        "second_last_name": "Rodriguez",
        "identification_type": "CC",
        "account_type": "SAVINGS",
        "account_number": "03693105175",
        "first_name": "Alberto",
        "second_name": "Daniel",
        "first_last_name": "Benhumea",
        "identification_number": "000000HUGO0001001"
    },
    "payment": {
        "breb_recipient_id": "8960ab35-0510-496f-970e-32073e99c13e",
        "account_id": "5acacacf-23e5-434a-af80-4a91aafc1612",
        "amount": {
            "currency": "COP",
            "value": "100000"
        },
        "id": "626927cc-7caa-4f9e-8bf2-18bb2aa34f4d",
        "reference": "Cafe - Juan Valdez tienda abc",
        "status": "PENDING"
    }
}
Copy

It is used to display, within the user's banking app, the payment details for a service, including the account owner's information, ensuring transparency as mandated by the Bre-B network.

Depending on the Model of Operation used, the details presented to the user may vary. For example, in the aggregator model, it will display the details of the Payment Gateway or Aggregator instead of the merchant's information. As a result, users will not have access to the data of the merchant they are paying.

Last updated on