Skip to main content
GET
/
v1
/
transactions
/
overview
Get company transactions overview
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/transactions/overview \
  --header 'x-api-key: <api-key>'
{
  "by_status": {
    "PROCESSING": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "AUTHORIZED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "APPROVED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "REFUNDED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "PARTIALLY_REFUNDED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "PENDING_REFUND": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "CHARGEDBACK": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "WAITING_PAYMENT": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "AWAITING_3DS": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "REFUSED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "FAILED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "EXPIRED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "PENDING_CANCELLATION": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    },
    "CANCELLED": {
      "count": 150,
      "volume": 1500000,
      "average": 10000
    }
  },
  "daily_aggregation": [
    {
      "date": "2025-01-15",
      "count": 10,
      "volume": 100000
    }
  ]
}

Documentation Index

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

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

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Query Parameters

​
created_at_from
string<date>
required

Start creation date (inclusive). Local calendar day in time_zone. Format is YYYY-MM-DD.

​
created_at_to
string<date>
required

End creation date (inclusive). Local calendar day in time_zone. Format is YYYY-MM-DD. Must be later or equal to created_at_from. Max range is 90 days.

​
time_zone
string
default:America/Sao_Paulo

IANA time zone used to interpret dates and group by local day. Defaults to America/Sao_Paulo.

Response

Overview of company transactions

Overview of merchant transactions grouped by status with daily aggregation

​
by_status
object
required

Statistics for each transaction status. All possible statuses are included, even if count is zero.

​
daily_aggregation
object[]
required

Daily aggregation of successful transactions (APPROVED, AUTHORIZED) only