> ## 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 banking statement for a specific merchant > Returns paginated account statement for a merchant that belongs to the authenticated organization company ## OpenAPI ````yaml /api-spec.yaml get /v1/merchants/{merchantId}/statement 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: Cards description: Stored card management (self and merchant) - 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 paths: /v1/merchants/{merchantId}/statement: get: tags: - Banking summary: Get banking statement for a specific merchant description: >- Returns paginated account statement for a merchant that belongs to the authenticated organization company parameters: - in: path name: merchantId required: true schema: type: string description: The merchant ID example: 123e4567-e89b-12d3-a456-426614174000 - in: query name: provider schema: type: string enum: - CELCOIN - RINNE - CAPPTA required: false description: >- Banking provider name (accepts lowercase and uppercase, returns uppercase, defaults to CELCOIN) example: CELCOIN - in: query name: date_from required: true schema: type: string format: date-time description: Start datetime (ISO 8601) inclusive example: '2025-01-01T00:00:00.000Z' - in: query name: date_to required: true schema: type: string format: date-time description: End datetime (ISO 8601) inclusive example: '2025-01-31T23:59:59.999Z' - in: query name: page schema: type: integer minimum: 1 default: 1 required: false description: Page number example: 1 - in: query name: limit schema: type: integer minimum: 1 maximum: 50 default: 50 required: false description: Page size (max 50) example: 50 - in: query name: order schema: type: string enum: - ASC - DESC default: DESC required: false description: Sort order by occurrence date example: DESC responses: '200': description: Statement retrieved successfully content: application/json: schema: $ref: '#/components/schemas/GetStatementResponse' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/AuthenticationErrorResponse' '404': description: >- Merchant not found or does not belong to authenticated organization company content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' security: - ApiKeyAuth: [] components: schemas: GetStatementResponse: type: object description: Banking statement response properties: company_id: type: string format: uuid description: Company ID example: 123e4567-e89b-12d3-a456-426614174000 provider: type: string enum: - CELCOIN - RINNE - CAPPTA description: Banking provider name example: CELCOIN items: type: array description: Statement items items: type: object properties: movement_id: type: - string - 'null' description: Movement ID example: 123e4567-e89b-12d3-a456-426614174000 occurred_at: type: string format: date-time description: Movement occurrence timestamp example: '2025-01-01T10:00:00.000Z' amount: type: integer description: Movement amount in cents example: 10000 type: type: string enum: - CREDIT - DEBIT description: Movement type example: CREDIT movement_type: type: string enum: - TEFTRANSFERIN - TEFTRANSFEROUT - PIXPAYMENTIN - PIXPAYMENTOUT - PIXREVERSALOUT - PIXREVERSALIN - TEDTRANSFERIN - TEDTRANSFEROUT - TEDREVERSALOUT - TEDREVERSALIN - CHARGEIN - BILLPAYMENT - BILLPAYMENTCHARGEBACK - RECHARGE - RECHARGECHARGEBACK - SLC - JUDICIALMOVEMENTOUT - JUDICIALMOVEMENTIN - ENTRYCREDIT - ENTRYDEBIT - BLOCKEDAMOUNT - UNLOCKEDAMOUNT description: Specific movement type example: PIXPAYMENTIN status_description: type: - string - 'null' description: Status description example: Processed successfully balance_before: type: - integer - 'null' description: Balance before movement in cents example: 95000 balance_after: type: - integer - 'null' description: Balance after movement in cents example: 105000 name_credit: type: - string - 'null' description: Credit party name example: John Doe name_debit: type: - string - 'null' description: Debit party name example: Jane Smith page: type: integer description: Current page number example: 1 page_size: type: integer description: Page size example: 50 total: type: integer description: Total number of items example: 150 total_pages: type: integer description: Total number of pages example: 3 currency: type: string enum: - BRL description: Currency code example: BRL required: - company_id - provider - items - page - page_size - total - total_pages - currency 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 NotFoundErrorResponse: type: object properties: error: type: object properties: code: type: string example: RESOURCE_NOT_FOUND message: type: string example: Company with ID '123' not found status: type: integer example: 404 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 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 securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: Company API key for authentication ````