Organization

Overview

Four endpoints describe who you are on Compago.

Endpoint	Returns
`GET /developer/v1/organization`	Your profile and registered business details
`GET /developer/v1/organization/member`	The people who can sign in to your dashboard
`GET /developer/v1/salesperson`	Your point-of-sale operators
`GET /developer/v1/promotion`	Promotions you fund or benefit from

Your organization

These examples call the production host. While you build, replace https://api-harmony.compago.com with https://demo-api-harmony.compago.com and use a key from the Demo dashboard. See Environments.

curl https://api-harmony.compago.com/api/developer/v1/organization \
  -H "x-api-key: $COMPAGO_API_KEY"

{
  "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "name": "Tienda Ejemplo",
  "slug": "tienda-ejemplo",
  "createdAt": "2025-11-02T10:00:00.000Z",
  "business": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Tienda Ejemplo SA de CV",
    "type": "MERCHANT",
    "category": "RETAIL",
    "rfc": "XAXX010101000",
    "phone": "+525512345678",
    "websiteUrl": "https://tienda.example.com",
    "createdAt": "2025-11-02T10:00:00.000Z",
    "address": {
      "addressLine": "Av. Reforma 100",
      "colony": "Juarez",
      "municipality": "Cuauhtemoc",
      "city": "Ciudad de Mexico",
      "state": "CDMX",
      "zip": "06600",
      "country": "MX"
    }
  }
}

This is the cheapest way to confirm a key works and to discover which organization it is bound to.

Your bank account and settlement details are not part of this response and are not readable through this API at all.

Members

curl "https://api-harmony.compago.com/api/developer/v1/organization/member?limit=50" \
  -H "x-api-key: $COMPAGO_API_KEY"

{
  "data": [
    {
      "id": "22222222-3333-4444-5555-666666666666",
      "role": "owner",
      "createdAt": "2025-11-02T10:00:00.000Z",
      "user": { "id": "33333333-...", "name": "Ana Ramirez", "email": "ana@example.com" }
    }
  ],
  "pagination": { "limit": 50, "hasMore": false, "nextCursor": null }
}

Roles are owner, admin and member, oldest member first. The projection is deliberately narrow: name, email and role, and nothing else about the person.

Salespeople

curl "https://api-harmony.compago.com/api/developer/v1/salesperson?status=ACTIVE" \
  -H "x-api-key: $COMPAGO_API_KEY"

{
  "id": "44444444-5555-6666-7777-888888888888",
  "name": "Luis Torres",
  "description": "Sucursal Centro",
  "username": "luis.torres",
  "status": "ACTIVE",
  "createdAt": "2026-01-15T09:00:00.000Z",
  "updatedAt": "2026-02-01T09:00:00.000Z"
}

Salespeople are the operators who sign in to your card terminals. Use this list to attribute sales to a person or to reconcile terminal activity against your staff roster.

Credentials are never returned. The password hash and the device token that signs an operator out everywhere are not even read from the database by this API.

Promotions

curl "https://api-harmony.compago.com/api/developer/v1/promotion?status=ACTIVE" \
  -H "x-api-key: $COMPAGO_API_KEY"

A promotion lets one organization absorb part of the fee on another’s payments, which is how a manufacturer funds months-without-interest on a retailer’s sales. The list returns both directions, and ownedByOrganization tells them apart:

true: your organization created and funds this promotion. The take is a cost to you.
false: your organization was invited and benefits. The discount reduces your fee.

{
  "id": "55555555-6666-7777-8888-999999999999",
  "title": "MSI Buen Fin",
  "description": "6 MSI sin costo para el comercio",
  "status": "ACTIVE",
  "take": 50,
  "discountMode": "CUSTOM",
  "discount": 0,
  "ownedByOrganization": false,
  "paymentPlans": [{ "id": "66666666-...", "paymentFeeId": "77777777-...", "discount": 100 }]
}

Get Started

Core Concepts

Developer API

Accept Payments

Integrations

Overview

Your organization

Members

Salespeople

Promotions

​Overview

​Your organization

​Members

​Salespeople

​Promotions

Overview

Your organization

Members

Salespeople

Promotions