Skip to main content
GET
/
v1
/
merchants
/
transactions
/
overview
Get merchant transactions overview
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/transactions/overview \
  --header 'x-api-key: <api-key>'
{
  "success": {
    "count": 150,
    "volume": 1500000,
    "average": 10000.5
  },
  "failure": {
    "count": 25,
    "volume": 250000,
    "average": 10000
  },
  "daily_aggregation": [
    {
      "date": "2025-01-15",
      "count": 10,
      "volume": 100000
    }
  ]
}

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.

merchant_id
string

Merchant ID

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 merchant transactions

Overview of merchant transactions with success and failure statistics

success
object
required

Statistics for successful transactions ((APPROVED, AUTHORIZED))

failure
object
required

Statistics for failed transactions (CHARGEDBACK, REFUSED, EXPIRED, PENDING_REFUND, REFUNDED)

daily_aggregation
object[]
required

Daily aggregation of successful transactions