Referência

As rotas Public MRR expõem métricas de receita da loja para integração com plataformas Trust MRR ou para exibir no seu site ou dashboard. Elas existem na v1 e na v2 (https://api.abacatepay.com/v2/public-mrr/...).

Autenticação

Toda chamada usa o token mrr_... gerado no app Trust MRR do dashboard, no header Authorization: Bearer. O token só dá acesso às rotas de Public MRR, na v1 e na v2, e é ele que você entrega a uma plataforma de terceiros.

Estrutura

Merchant (`/public-mrr/merchant-info`)

Dados básicos da loja:

{
  "data": {
    "id": "store_abc123xyz",
    "name": "Example Tech",
    "website": "https://www.example.com",
    "createdAt": "2024-12-06T18:53:31.756Z",
    "country": "BR"
  },
  "success": true,
  "error": null
}

MRR (`/public-mrr/mrr`)

Receita recorrente mensal e total de assinaturas ativas:

{
  "data": {
    "mrr": { "currency": "BRL", "value": 129900 },
    "totalActiveSubscriptions": { "currency": "BRL", "value": 12 }
  },
  "success": true,
  "error": null
}

MRR por dia (`/public-mrr/mrr-by-day`)

MRR no fim de cada dia do período, com até 366 dias:

{
  "data": {
    "2024-01-15": { "mrr": 129900 },
    "2024-01-16": { "mrr": 134900 }
  },
  "success": true,
  "error": null
}

Receita por período (`/public-mrr/revenue`)

Totais e transações por dia:

{
  "data": {
    "totalRevenue": 8000,
    "totalTransactions": 5,
    "transactionsPerDay": {
      "2024-01-15": { "amount": 5000, "count": 3 },
      "2024-01-16": { "amount": 3000, "count": 2 }
    }
  },
  "success": true,
  "error": null
}

Atributos

Merchant (merchant-info):

Atributo	Tipo	Descrição
`id`	string	ID único da loja
`name`	string	Nome da loja
`website`	string	Site da loja
`createdAt`	string	Data de criação (ISO 8601)
`country`	string	País da loja (`BR`)

MRR (mrr):

Atributo	Tipo	Descrição
`mrr`	object	Receita recorrente mensal das assinaturas pagantes, em centavos, em `mrr.value`. Cada assinatura entra com o valor de um mês: a anual conta 1/12, a trimestral 1/3, e assim por diante
`totalActiveSubscriptions`	object	Assinaturas ativas, incluindo as em período de teste, em `totalActiveSubscriptions.value`

MRR por dia (mrr-by-day):

Atributo	Tipo	Descrição
chave	string	Dia no formato `YYYY-MM-DD`
`mrr`	number	MRR em centavos no fim daquele dia, no horário de Brasília

Receita (revenue):

Atributo	Tipo	Descrição
`totalRevenue`	number	Receita total do período em centavos
`totalTransactions`	integer	Número de transações no período
`transactionsPerDay`	object	Por dia (chave = data YYYY-MM-DD); cada valor tem `amount` (centavos) e `count`

Valores monetários vêm em centavos. Divida por 100 para reais (ex.: 150000 = R$ 1.500,00).

Introdução

Cobrar com Checkout

Links de pagamento

Clientes

Portal do cliente

Checkout Transparente

Cupons

Produtos

Webhooks

Assinaturas

Saques

PIX

Extrato

Loja

Public MRR

Autenticação

Estrutura

Merchant (`/public-mrr/merchant-info`)

MRR (`/public-mrr/mrr`)

MRR por dia (`/public-mrr/mrr-by-day`)

Receita por período (`/public-mrr/revenue`)

Atributos

​Autenticação

​Estrutura

​Merchant (/public-mrr/merchant-info)

​MRR (/public-mrr/mrr)

​MRR por dia (/public-mrr/mrr-by-day)

​Receita por período (/public-mrr/revenue)

​Atributos

Autenticação

Estrutura

Merchant (`/public-mrr/merchant-info`)

MRR (`/public-mrr/mrr`)

MRR por dia (`/public-mrr/mrr-by-day`)

Receita por período (`/public-mrr/revenue`)

Atributos