Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

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"
  },
  "error": null
}

MRR (/public-mrr/mrr)

Receita recorrente mensal:
{
  "data": {
    "mrr": 0,
    "totalActiveSubscriptions": 0
  },
  "error": null
}

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

Totais e transações por dia:
{
  "data": {
    "totalRevenue": 150000,
    "totalTransactions": 45,
    "transactionsPerDay": {
      "2024-01-15": { "amount": 5000, "count": 3 },
      "2024-01-16": { "amount": 3000, "count": 2 }
    }
  },
  "error": null
}

Atributos

Merchant (merchant-info):
AtributoTipoDescrição
idstringID único da loja
namestringNome da loja
websitestringSite da loja
createdAtstringData de criação (ISO 8601)
MRR (mrr):
AtributoTipoDescrição
mrrnumberReceita recorrente mensal em centavos (0 = nenhuma)
totalActiveSubscriptionsintegerQuantidade de assinaturas ativas (0 = nenhuma)
Receita (revenue):
AtributoTipoDescrição
totalRevenuenumberReceita total do período em centavos
totalTransactionsintegerNúmero de transações no período
transactionsPerDayobjectPor 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).