Skip to main content
GET
Obter receita por período
Retorna a receita e o número de transações entre startDate e endDate, no total e por dia, no horário de Brasília.
Use o token mrr_ do plugin Public MRR, não a chave de API.

Entenda o Public MRR

Como gerar o token e como a receita é somada.
Erros comuns:

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

startDate
string<date>
required

Data de início do período (formato YYYY-MM-DD)

Example:

"2024-01-01"

endDate
string<date>
required

Data de fim do período (formato YYYY-MM-DD)

Example:

"2024-01-31"

Response

Dados de receita retornados com sucesso.

data
object
error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true