> ## 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 public settings for a merchant > Returns public settings for a merchant including rinne-js configuration and available payment methods. This is a public endpoint that does not require authentication. The available payment methods are collected from all active and enabled affiliations for the merchant. ## OpenAPI ````yaml /api-spec.yaml get /v1/merchants/{merchantId}/public-settings 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}/public-settings: get: tags: - Management summary: Get public settings for a merchant description: > Returns public settings for a merchant including rinne-js configuration and available payment methods. This is a public endpoint that does not require authentication. The available payment methods are collected from all active and enabled affiliations for the merchant. parameters: - in: path name: merchantId required: true schema: type: string description: Merchant ID example: 123e4567-e89b-12d3-a456-426614174000 responses: '200': description: Public settings retrieved successfully content: application/json: schema: $ref: '#/components/schemas/PublicSettingsResponse' example: merchant_id: merchant_1234567890 team_id: team_1234567890 app_id: app_1234567890 name: Example Merchant available_methods: - CREDIT_CARD - DEBIT_CARD - PIX '404': description: Merchant not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' components: schemas: PublicSettingsResponse: type: object description: > Public settings for a merchant including encryption configuration and available payment methods. This endpoint is public and does not require authentication. required: - merchant_id - team_id - app_id - name - available_methods properties: merchant_id: type: string description: Merchant ID, required by rinne-js example: test-merchant-id team_id: type: string description: Team ID, required by rinne-js example: test-team-id app_id: type: string description: App ID, required by rinne-js example: test-app-id name: type: string description: Merchant name (falls back to full_name if name is not available) example: Example Merchant available_methods: type: array description: > List of available payment methods from all active and enabled affiliations. Payment methods are deduplicated across all affiliations. items: type: string enum: - CREDIT_CARD - DEBIT_CARD - PIX - BOLEPIX example: - CREDIT_CARD - PIX 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 ````