Skip to main content
GET
/
v1
/
merchants
/
overview
Get merchant overview
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/overview \
  --header 'x-api-key: <api-key>'
{
  "top_by_volume": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Acme Store",
      "transaction_volume": 1500000,
      "transaction_count": 150
    }
  ],
  "top_by_count": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Acme Store",
      "transaction_volume": 1500000,
      "transaction_count": 150
    }
  ],
  "new_count": 25
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Query Parameters

​
created_at_from
string<date-time>
required

Start creation datetime (ISO 8601) inclusive. Must be earlier than created_at_to. Max range is 90 days.

​
created_at_to
string<date-time>
required

End creation datetime (ISO 8601) inclusive. Must be later than created_at_from. Max range is 90 days.

Response

Overview of merchant

Overview of merchant data

​
top_by_volume
object[]
required

Top 5 merchants by transaction volume

​
top_by_count
object[]
required

Top 5 merchants by transaction count

​
new_count
integer
required

Number of merchants created in the specified period

Example:

25