> ## 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. # Get merchant transactions overview > Requires the merchant.transaction.list permission. Returns an overview of transactions for the authenticated company with aggregated statistics by status and a daily breakdown of successful transactions only (APPROVED, AUTHORIZED) ## OpenAPI ````yaml /api-spec.yaml get /v1/merchants/transactions/overview openapi: 3.1.0 info: title: Rinne API version: 1.0.0 description: > **Rinne API** is a robust payment platform that offers integration with multiple payment providers. ## Authentication The API uses API Key authentication via the `x-api-key` header. Each company has a unique key to access resources. ## Response Format All responses follow a consistent format: - **Success**: Returns the requested data directly - **Error**: Returns an `error` object with detailed information ## Pagination Endpoints that return lists support pagination through parameters: - `page`: Page number (default: 1) - `limit`: Items per page (default: 20, maximum: 100) ## Supported Providers The API supports multiple payment providers: - **Rinne**: Internal provider - **Celcoin**: PIX integration and other financial services ## Raw Card Data (PCI Endpoints) Card credential fields (`card_data.number`, `card_data.cvv`, `card_data.network_token`, `card_data.cryptogram`, and the 3DS `card.number`) must always be sent encrypted — values start with the `ev:` prefix. Plaintext values are rejected with `400 VALIDATION_ERROR` on every host. There are two ways to send encrypted values: - **rinne-js**: card forms and wallet buttons (Apple Pay / Google Pay) encrypt credentials client-side before they leave the browser. - **PCI API host**: server-to-server integrations that handle raw card data must call `https://pci.api.rinne.com.br/core` (sandbox: `https://pci.api-sandbox.rinne.com.br/core`) instead of the regular host. This endpoint encrypts `number` and `cvv` in transit before the request reaches the API; all other fields pass through unchanged. The PCI host serves only transaction creation and 3DS session creation (both the self and merchant variants); use the regular host for everything else. contact: name: Rinne API Support email: suporte@rinne.com.br servers: - url: https://api-sandbox.rinne.com.br/core description: Sandbox - url: https://api.rinne.com.br/core description: Production security: [] tags: - name: System description: System and API health endpoints - name: Authentication description: User authentication and authorization endpoints - name: Management description: >- Merchant management endpoints - create, list, get specific, overview, update - name: Transactions description: Transaction operations for merchants - create, list, overview, refunds - name: Affiliations description: Affiliation management for merchants - name: Banking description: Banking operations for merchants - balance, cashout, statements - name: Bank Accounts description: Bank account management for merchants - name: Pix Keys description: PIX key management for merchants - name: Company Transactions description: Direct transaction management and query endpoints for companies - name: Companies description: Company management - name: Company Affiliations description: Payment provider affiliation management - name: Company Banking description: Company banking endpoints (balance, etc.) - name: Company Pix description: Company PIX key management - name: Company Ledger description: Company ledger entry query endpoints - name: Ledger description: Ledger entry query endpoints (company and merchants) - name: Webhooks description: Endpoints for receiving webhooks from external providers - name: Pricing description: Fee and cost policy management for transaction pricing - name: Users description: User management endpoints - name: Roles description: Role management endpoints - name: Permissions description: Permission management endpoints - name: Admin description: Admin management endpoints x-scalar-ignore: true paths: /v1/merchants/transactions/overview: get: tags: - Transactions summary: Get merchant transactions overview description: > Requires the merchant.transaction.list permission. Returns an overview of transactions for the authenticated company with aggregated statistics by status and a daily breakdown of successful transactions only (APPROVED, AUTHORIZED) parameters: - in: query name: created_at_from required: true schema: type: string format: date description: >- Start creation date (inclusive). Local calendar day in `time_zone`. Format is YYYY-MM-DD. example: '2025-01-01' - in: query name: created_at_to required: true schema: type: string format: date description: >- 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. example: '2025-01-31' - in: query name: merchant_id required: false schema: type: string description: Merchant ID example: 123e4567-e89b-12d3-a456-426614174000 - in: query name: time_zone required: false schema: type: string default: America/Sao_Paulo description: >- IANA time zone used to interpret dates and group by local day. Defaults to `America/Sao_Paulo`. example: America/Sao_Paulo responses: '200': description: Overview of merchant transactions content: application/json: schema: $ref: '#/components/schemas/TransactionOverviewResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/AuthenticationErrorResponse' '403': description: Insufficient permissions to access this resource content: application/json: schema: $ref: '#/components/schemas/AuthorizationErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' security: - ApiKeyAuth: [] components: schemas: TransactionOverviewResponse: type: object description: >- Overview of merchant transactions grouped by status with daily aggregation properties: by_status: type: object description: >- Statistics for each transaction status. All possible statuses are included, even if count is zero. properties: PROCESSING: $ref: '#/components/schemas/TransactionStatusStats' AUTHORIZED: $ref: '#/components/schemas/TransactionStatusStats' APPROVED: $ref: '#/components/schemas/TransactionStatusStats' REFUNDED: $ref: '#/components/schemas/TransactionStatusStats' PARTIALLY_REFUNDED: $ref: '#/components/schemas/TransactionStatusStats' PENDING_REFUND: $ref: '#/components/schemas/TransactionStatusStats' CHARGEDBACK: $ref: '#/components/schemas/TransactionStatusStats' WAITING_PAYMENT: $ref: '#/components/schemas/TransactionStatusStats' AWAITING_3DS: $ref: '#/components/schemas/TransactionStatusStats' REFUSED: $ref: '#/components/schemas/TransactionStatusStats' FAILED: $ref: '#/components/schemas/TransactionStatusStats' EXPIRED: $ref: '#/components/schemas/TransactionStatusStats' PENDING_CANCELLATION: $ref: '#/components/schemas/TransactionStatusStats' CANCELLED: $ref: '#/components/schemas/TransactionStatusStats' required: - PROCESSING - AUTHORIZED - APPROVED - REFUNDED - PARTIALLY_REFUNDED - PENDING_REFUND - CHARGEDBACK - WAITING_PAYMENT - AWAITING_3DS - REFUSED - FAILED - EXPIRED - PENDING_CANCELLATION - CANCELLED daily_aggregation: type: array description: >- Daily aggregation of successful transactions (APPROVED, AUTHORIZED) only items: type: object properties: date: type: string format: date description: Date in YYYY-MM-DD format example: '2025-01-15' count: type: integer description: Number of successful transactions on this date example: 10 volume: type: integer description: Total volume of successful transactions on this date in cents example: 100000 required: - date - count - volume required: - by_status - daily_aggregation ValidationErrorResponse: type: object properties: error: type: object properties: code: type: string example: VALIDATION_ERROR message: type: string example: Validation error status: type: integer example: 400 details: type: object properties: issues: type: array items: type: object properties: field: type: string example: email type: type: string example: REQUIRED message: type: string example: Field 'email' is required value: anyOf: - type: string - type: number - type: boolean example: invalid_value constraints: type: object example: min: 18 max: 120 path: type: string example: /companies timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 AuthenticationErrorResponse: type: object properties: error: type: object properties: code: type: string example: AUTHENTICATION_ERROR message: type: string example: Authentication required to access this resource status: type: integer example: 401 details: type: object properties: reason: type: string example: Invalid API key path: type: string example: /companies/me timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 AuthorizationErrorResponse: type: object properties: error: type: object properties: code: type: string example: AUTHORIZATION_ERROR message: type: string example: You need 'admin' permissions to access this resource status: type: integer example: 403 path: type: string example: /companies timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 InternalServerErrorResponse: type: object properties: error: type: object properties: code: type: string example: INTERNAL_SERVER_ERROR message: type: string example: An unexpected error occurred status: type: integer example: 500 path: type: string example: /companies timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 TransactionStatusStats: type: object description: Statistics for a specific transaction status properties: count: type: integer description: Number of transactions with this status example: 150 volume: type: integer description: Total volume of transactions with this status in cents example: 1500000 average: type: integer description: >- Average amount of transactions with this status in cents (rounded to nearest cent value) example: 10000 required: - count - volume - average securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: Company API key for authentication ````