# Rinne API

> Complete payment infrastructure platform for managing merchants, processing transactions, and handling banking operations through a unified API.

## Docs

- [Introduction](https://docs.rinne.com.br/index.md): Complete payment infrastructure platform for managing merchants, processing transactions, and handling banking operations through a unified API.
- [Quickstart](https://docs.rinne.com.br/quickstart.md): Get started with Rinne API in minutes
- [Organizations and merchants](https://docs.rinne.com.br/concepts/organizations-and-merchants.md): Understand the company hierarchy in Rinne's B2B2B model
- [Affiliations](https://docs.rinne.com.br/concepts/affiliations.md): Connect merchants to payment providers for transaction processing
- [KYC Verification](https://docs.rinne.com.br/concepts/kyc.md): How Rinne automatically verifies merchant identity data and reports the results to your organization via the kyc.completed webhook
- [Transactions](https://docs.rinne.com.br/concepts/transactions.md): Process and manage payment transactions
- [Banking](https://docs.rinne.com.br/concepts/banking.md): Manage balances, review statements, receive PIX payments, perform internal transfers, configure automatic settlements, and tracking court-ordered fund blocks on affiliation bank accounts.
- [Cashouts](https://docs.rinne.com.br/concepts/cashouts.md): Understand outbound PIX transfers—origins and destinations, how they map to the API, lifecycle states, and reconciliation
- [Pricing](https://docs.rinne.com.br/concepts/pricing.md): Flexible rule-based pricing for fees and costs
- [Ledger entries](https://docs.rinne.com.br/concepts/ledger-entries.md): Understanding Rinne's double-entry accounting system for tracking all monetary movements
- [Settlement items](https://docs.rinne.com.br/concepts/settlement-items.md): Understanding how Rinne tracks actual money movements and settles ledger entries
- [Authentication](https://docs.rinne.com.br/guides/authentication.md): Learn how to authenticate with the Rinne API using API keys and JWT tokens
- [Testing](https://docs.rinne.com.br/guides/testing.md): Reproduce card approvals, declines, and provider errors on demand with deterministic sandbox test scenarios.
- [PIX payments](https://docs.rinne.com.br/guides/pix-payments.md): Process instant payments using Brazil's PIX system
- [Cashouts](https://docs.rinne.com.br/guides/cashouts.md): Cash out via PIX using an origin account and an external destination
- [Card transactions](https://docs.rinne.com.br/guides/card-transactions.md): Implement credit and debit card transaction flows, challenge strategy flags, and 3DS transitions.
- [Cards on file](https://docs.rinne.com.br/guides/cards-on-file.md): Store encrypted card credentials on file and charge them later with a stable card reference, without your systems handling raw card numbers.
- [Wallet transactions](https://docs.rinne.com.br/guides/wallet-transactions.md): Process Apple Pay and Google Pay transactions through your backend using rinne-js payloads.
- [3D Secure authentication](https://docs.rinne.com.br/guides/three-d-secure-authentication.md): Implement official 3DS session-first and transaction-first flows with self and merchant endpoints.
- [Webhooks](https://docs.rinne.com.br/guides/webhooks.md): Receive real-time event notifications from Rinne
- [User management](https://docs.rinne.com.br/guides/user-management.md): Manage users, roles, and permissions
- [Error handling](https://docs.rinne.com.br/guides/error-handling.md): Understand and handle API errors
- [Rate limits](https://docs.rinne.com.br/guides/rate-limits.md): How Rinne's request rate limits work, which endpoints they apply to, and how to build integrations that stay within them.
- [rinne-js](https://docs.rinne.com.br/rinne-js/index.md): Browser SDK for Apple Pay, Google Pay, card collection, and 3D Secure authentication.
- [Installation](https://docs.rinne.com.br/rinne-js/installation.md): Install and initialize rinne-js with package managers or CDN.
- [Quickstart](https://docs.rinne.com.br/rinne-js/quickstart.md): Accept wallet and card payments with 3D Secure using rinne-js.
- [Live Demo](https://docs.rinne.com.br/rinne-js/live-demo.md): Try Apple Pay, Google Pay, and card collection in an interactive sandbox checkout.
- [Transactions](https://docs.rinne.com.br/rinne-js/transactions.md): Create payment transactions and understand defaults and payload structure.
- [Wallet Elements](https://docs.rinne.com.br/rinne-js/wallet-elements.md): Configure and mount Apple Pay and Google Pay elements with shared handlers.
- [Card Element](https://docs.rinne.com.br/rinne-js/card-element.md): Collect encrypted card data with validation state, field events, and theme customization.
- [3D Secure Element](https://docs.rinne.com.br/rinne-js/three-d-secure-element.md): Mount the element that runs 3DS authentication — frictionless and challenge — and handle success, failure, and retry flows.
- [Guide: Wallet Checkout](https://docs.rinne.com.br/rinne-js/guides/wallet-checkout.md): Implement a production-ready Apple Pay and Google Pay checkout flow with backend processing.
- [Guide: Card + 3DS Checkout](https://docs.rinne.com.br/rinne-js/guides/card-3ds-checkout.md): Implement card payments with 3D Secure using session-first or transaction-first flows.
- [Errors and Debugging](https://docs.rinne.com.br/rinne-js/errors-and-debugging.md): Handle SDK errors consistently and troubleshoot wallet, card, and 3DS integrations.
- [Requirements and Support](https://docs.rinne.com.br/rinne-js/requirements-and-support.md): Production requirements, CSP, browser support, and operational guidance for rinne-js.
- [API Reference](https://docs.rinne.com.br/api-reference/introduction.md): Complete reference for the Rinne API
- [List merchants](https://docs.rinne.com.br/api-reference/management/list-merchants.md): Requires the merchant.company.list permission.
- [Create new merchant](https://docs.rinne.com.br/api-reference/management/create-new-merchant.md): Requires the merchant.company.create permission.
- [Get merchant by ID](https://docs.rinne.com.br/api-reference/management/get-merchant-by-id.md): Requires the merchant.company.view permission.
- [Update merchant](https://docs.rinne.com.br/api-reference/management/update-merchant.md): Requires the merchant.company.edit permission.
- [Get public settings for a merchant](https://docs.rinne.com.br/api-reference/management/get-public-settings-for-a-merchant.md): 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.
- [Get merchant overview](https://docs.rinne.com.br/api-reference/management/get-merchant-overview.md): Requires the merchant.company.list permission.
- [Create a new transaction for a specific merchant](https://docs.rinne.com.br/api-reference/transactions/create-a-new-transaction-for-a-specific-merchant.md): Requires the merchant.transaction.create permission.
- [Create a 3D Secure session linked to a merchant](https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant.md): Creates a standalone 3D Secure (3DS) authentication session for a card payment. Requires the merchant.3ds.create permission.
- [Authenticate a merchant's transaction with 3D Secure](https://docs.rinne.com.br/api-reference/3d-secure/authenticate-a-merchants-transaction-with-3d-secure.md): Authenticates a transaction that is in AWAITING_3DS status using a 3D Secure session. Links the authenticated session to the transaction, updates card data with 3DS authentication details (cryptogram, ECI, authentication_type), and processes the payment with the provider. Requires the merchant.trans…
- [Get transactions for all merchants](https://docs.rinne.com.br/api-reference/transactions/get-transactions-for-all-merchants.md): Requires the merchant.transaction.list permission.
- [Get a specific transaction by ID across all merchants](https://docs.rinne.com.br/api-reference/transactions/get-a-specific-transaction-by-id-across-all-merchants.md): Requires the merchant.transaction.view permission.
- [Get a specific transaction for a merchant](https://docs.rinne.com.br/api-reference/transactions/get-a-specific-transaction-for-a-merchant.md): Requires the merchant.transaction.view permission.
- [Get transaction receipts for a specific merchant](https://docs.rinne.com.br/api-reference/transactions/get-transaction-receipts-for-a-specific-merchant.md): Requires the merchant.transaction.view permission.
- [Refund a transaction for a specific merchant](https://docs.rinne.com.br/api-reference/transactions/refund-a-transaction-for-a-specific-merchant.md): Requires the merchant.transaction.refund permission.
- [Cancel existing pending refund for a merchant transaction by ID](https://docs.rinne.com.br/api-reference/transactions/cancel-existing-pending-refund-for-a-merchant-transaction-by-id.md): Requires the merchant.transaction.refund permission.
- [Cancel a merchant's BOLEPIX transaction](https://docs.rinne.com.br/api-reference/transactions/cancel-a-merchants-bolepix-transaction.md): Cancel a BOLEPIX transaction for a specific merchant that is in WAITING_PAYMENT status. Only BOLEPIX payment method transactions can be cancelled. Requires the merchant.transaction.cancel permission.
- [Get merchant transactions overview](https://docs.rinne.com.br/api-reference/transactions/get-merchant-transactions-overview.md): Requires the merchant.transaction.list permission.
- [Pay PIX or BOLEPIX transaction via QR code (Sandbox Only)](https://docs.rinne.com.br/api-reference/transactions/pay-pix-or-bolepix-transaction-via-qr-code-sandbox-only.md): Processes a PIX payment using a QR code from an existing transaction for testing purposes. **This endpoint is only available in sandbox environment.**
- [Store a card for a merchant](https://docs.rinne.com.br/api-reference/cards/store-a-card-for-a-merchant.md): Requires the merchant.card.create permission. The authenticated organization must own the merchant.
- [List a merchant's stored cards](https://docs.rinne.com.br/api-reference/cards/list-a-merchants-stored-cards.md): Requires the merchant.card.list permission. The authenticated organization must own the merchant.
- [Get a merchant's stored card](https://docs.rinne.com.br/api-reference/cards/get-a-merchants-stored-card.md): Requires the merchant.card.view permission. The authenticated organization must own the merchant.
- [Delete a merchant's stored card](https://docs.rinne.com.br/api-reference/cards/delete-a-merchants-stored-card.md): Requires the merchant.card.delete permission. The authenticated organization must own the merchant. Soft-deletes the card.
- [Get affiliations for all merchants](https://docs.rinne.com.br/api-reference/affiliations/get-affiliations-for-all-merchants.md): Requires the merchant.affiliation.list permission.
- [List affiliations for a specific merchant](https://docs.rinne.com.br/api-reference/affiliations/list-affiliations-for-a-specific-merchant.md): Requires the merchant.affiliation.list permission.
- [Create a new affiliation for a specific merchant](https://docs.rinne.com.br/api-reference/affiliations/create-a-new-affiliation-for-a-specific-merchant.md): Requires the merchant.affiliation.create permission.
- [Get a specific affiliation for a merchant](https://docs.rinne.com.br/api-reference/affiliations/get-a-specific-affiliation-for-a-merchant.md): Requires the merchant.affiliation.view permission.
- [Update anticipation configuration for a merchant's affiliation](https://docs.rinne.com.br/api-reference/affiliations/update-anticipation-configuration-for-a-merchants-affiliation.md): Requires the merchant.affiliation.edit permission.
- [Get onboarding document with download URL for a merchant's affiliation](https://docs.rinne.com.br/api-reference/affiliations/get-onboarding-document-with-download-url-for-a-merchants-affiliation.md): Requires the merchant.affiliation.view permission.
- [Request settlement bank account update for a merchant's affiliation](https://docs.rinne.com.br/api-reference/affiliations/request-settlement-bank-account-update-for-a-merchants-affiliation.md): Creates a new pending settlement bank account for a specific merchant's affiliation. Triggers a call to the payment provider to initiate bank account validation. The new account starts with PENDING_VALIDATION status; the current ACTIVE account continues to be used for card receivables settlements un…
- [Get banking balance for a specific merchant](https://docs.rinne.com.br/api-reference/banking/get-banking-balance-for-a-specific-merchant.md): Returns current banking balance for a merchant that belongs to the authenticated organization company
- [Add balance to merchant bank account (Sandbox Only)](https://docs.rinne.com.br/api-reference/banking/add-balance-to-merchant-bank-account-sandbox-only.md): Adds balance to a merchant's bank account for testing purposes. **This endpoint is only available in sandbox environment.**
- [Get banking statement for a specific merchant](https://docs.rinne.com.br/api-reference/banking/get-banking-statement-for-a-specific-merchant.md): Returns paginated account statement for a merchant that belongs to the authenticated organization company
- [List all PIX keys for a specific merchant](https://docs.rinne.com.br/api-reference/pix-keys/list-all-pix-keys-for-a-specific-merchant.md): Requires the merchant.pix.list permission.
- [Create a new PIX key for a specific merchant](https://docs.rinne.com.br/api-reference/pix-keys/create-a-new-pix-key-for-a-specific-merchant.md): Requires the merchant.pix.create permission.
- [Delete a PIX key for a specific merchant](https://docs.rinne.com.br/api-reference/pix-keys/delete-a-pix-key-for-a-specific-merchant.md): Requires the merchant.pix.delete permission.
- [Create a new internal transfer request](https://docs.rinne.com.br/api-reference/banking/create-a-new-internal-transfer-request.md): Creates a new internal transfer request for the authenticated company or a merchant company. Internal transfers move money between bank accounts within the same provider. The transfer will be processed by the provider and status updates will be received via webhooks. Only organization companies may…
- [List internal transfers for authenticated company](https://docs.rinne.com.br/api-reference/banking/list-internal-transfers-for-authenticated-company.md): Returns a paginated list of internal transfers for the authenticated company with optional filters. Internal transfers move money between bank accounts within the same provider. For organization users, the origin_bank_account_id and destination_bank_account_id parameters can be used to filter transf…
- [Get a specific internal transfer by ID](https://docs.rinne.com.br/api-reference/banking/get-a-specific-internal-transfer-by-id.md): Returns details of a specific internal transfer for the authenticated company. The internal transfer ID can be either the internal ID or the external request ID. Requires the banking.view permission.
- [List judicial blockages for a specific merchant](https://docs.rinne.com.br/api-reference/banking/list-judicial-blockages-for-a-specific-merchant.md): Returns a paginated list of judicial block/release movements for a merchant that belongs to the authenticated organization. Supports filtering by type, bank account, process number, and occurrence date range. Requires the merchant.banking.list permission.
- [List all PIX keys for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/list-all-pix-keys-for-a-merchant.md): Requires the merchant.banking.list permission.
- [Create a PIX key for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/create-a-pix-key-for-a-merchant.md): Requires the merchant.banking.create permission.
- [Get a PIX key for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/get-a-pix-key-for-a-merchant.md): Requires the merchant.banking.view permission.
- [Update a PIX key for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/update-a-pix-key-for-a-merchant.md): Requires the merchant.banking.edit permission.
- [Delete a PIX key for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/delete-a-pix-key-for-a-merchant.md): Requires the merchant.banking.delete permission.
- [List all bank accounts for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/list-all-bank-accounts-for-a-merchant.md): Requires the merchant.banking.list permission.
- [Registers a new external bank account for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/registers-a-new-external-bank-account-for-a-merchant.md): Registers a new external bank account for a merchant that belongs to the authenticated organization company
- [Get specific bank account details for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/get-specific-bank-account-details-for-a-merchant.md): Returns details of a specific bank account for a merchant that belongs to the authenticated organization company
- [Update bank account information for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/update-bank-account-information-for-a-merchant.md): Updates a specific bank account for a merchant that belongs to the authenticated organization company
- [Soft delete bank account for a merchant](https://docs.rinne.com.br/api-reference/bank-accounts/soft-delete-bank-account-for-a-merchant.md): Soft deletes a specific bank account for a merchant that belongs to the authenticated organization company
- [Create a cashout request for a specific merchant](https://docs.rinne.com.br/api-reference/banking/create-a-cashout-request-for-a-specific-merchant.md): Creates a new cashout request for a merchant that belongs to the authenticated organization
- [List cashouts for a specific merchant](https://docs.rinne.com.br/api-reference/banking/list-cashouts-for-a-specific-merchant.md): Returns paginated list of cashouts for a merchant that belongs to the authenticated organization
- [Get a specific cashout for a merchant](https://docs.rinne.com.br/api-reference/banking/get-a-specific-cashout-for-a-merchant.md): Returns details of a specific cashout for a merchant that belongs to the authenticated organization
- [Get merchant cashout receipt](https://docs.rinne.com.br/api-reference/banking/get-merchant-cashout-receipt.md): Generates a receipt for a merchant's cashout operation. Only accessible by the organization that owns the merchant. Returns JSON with cashout details, account information, and a base64-encoded PDF. Only available for cashouts with status COMPLETED, PARTIALLY_RETURNED, or RETURNED. Requires the casho…
- [Get ledger entries for all merchants](https://docs.rinne.com.br/api-reference/ledger/get-ledger-entries-for-all-merchants.md): Requires the merchant.ledger.list permission.
- [Get a single ledger entry by ID for organization](https://docs.rinne.com.br/api-reference/ledger/get-a-single-ledger-entry-by-id-for-organization.md): Requires the merchant.ledger.view permission.
- [Get ledger entries for a specific merchant](https://docs.rinne.com.br/api-reference/ledger/get-ledger-entries-for-a-specific-merchant.md): Requires the merchant.ledger.list permission.
- [List fee policies](https://docs.rinne.com.br/api-reference/pricing/list-fee-policies.md): Requires the fee_policy.list permission.
- [Create a new fee policy](https://docs.rinne.com.br/api-reference/pricing/create-a-new-fee-policy.md): Requires the fee_policy.create permission.
- [Update a fee policy](https://docs.rinne.com.br/api-reference/pricing/update-a-fee-policy.md): Requires the fee_policy.edit permission.
- [Replace a fee policy](https://docs.rinne.com.br/api-reference/pricing/replace-a-fee-policy.md): Replace an existing fee policy for the authenticated company. The final state of the policy will match exactly what is provided in the request.
- [List cost policies](https://docs.rinne.com.br/api-reference/pricing/list-cost-policies.md): Requires the cost_policy.list permission.
- [Get webhook dashboard URL](https://docs.rinne.com.br/api-reference/webhooks/get-webhook-dashboard-url.md): Requires the webhook.list permission.
- [Affiliation created](https://docs.rinne.com.br/api-reference/events/affiliation-created.md): Triggered when a new affiliation is created in the system.
- [Affiliation status changed](https://docs.rinne.com.br/api-reference/events/affiliation-status-changed.md): Triggered when an affiliation status changes (e.g., from PENDING_APPROVAL to ACTIVE).
- [Affiliation bank account operational status changed](https://docs.rinne.com.br/api-reference/events/affiliation-bank-account-operational-status-changed.md): Triggered when the operational status of an affiliation bank account changes, for example when a court order places the account under a judicial block (`JUDICIAL_BLOCK`) or when the block is lifted (`REGULAR`).
- [Cashout created](https://docs.rinne.com.br/api-reference/events/cashout-created.md): Triggered when a new cashout request is created in the system.
- [Cashout status changed](https://docs.rinne.com.br/api-reference/events/cashout-status-changed.md): Triggered when a cashout status changes throughout its lifecycle.
- [Company created](https://docs.rinne.com.br/api-reference/events/company-created.md): Triggered when a new company is created in the system.
- [Company status changed](https://docs.rinne.com.br/api-reference/events/company-status-changed.md): Triggered when a company status changes throughout its lifecycle.
- [Internal transfer created](https://docs.rinne.com.br/api-reference/events/internal-transfer-created.md): Triggered when a new internal transfer is created in the system.
- [Internal transfer status changed](https://docs.rinne.com.br/api-reference/events/internal-transfer-status-changed.md): Triggered when an internal transfer status changes throughout its lifecycle.
- [Judicial blockage created](https://docs.rinne.com.br/api-reference/events/judicial-blockage-created.md): Triggered when a judicial movement is recorded against an affiliation bank account. `type` distinguishes a blocked amount (`BLOCK`) from a released one (`RELEASE`), so both directions of a court-ordered movement arrive on this event.
- [Kyc completed](https://docs.rinne.com.br/api-reference/events/kyc-completed.md): Triggered when a KYC (Know Your Customer) check completes for a merchant company.
- [Ledger entry settled](https://docs.rinne.com.br/api-reference/events/ledger-entry-settled.md): Triggered when a ledger entry transitions from settled=false to settled=true.
- [Transaction created](https://docs.rinne.com.br/api-reference/events/transaction-created.md): Triggered when a new transaction is created in the system.
- [Transaction status changed](https://docs.rinne.com.br/api-reference/events/transaction-status-changed.md): Triggered when a transaction status changes throughout its lifecycle.
- [Get authenticated company information](https://docs.rinne.com.br/api-reference/companies/get-authenticated-company-information.md): Requires the company.list permission.
- [Update authenticated company](https://docs.rinne.com.br/api-reference/companies/update-authenticated-company.md): Requires the company.edit permission.
- [List all MCCs](https://docs.rinne.com.br/api-reference/companies/list-all-mccs.md): Requires the company.list permission.
- [List affiliations](https://docs.rinne.com.br/api-reference/company-affiliations/list-affiliations.md): Gets a list of affiliations for the authenticated company with optional filters and pagination. Requires the affiliation.list permission.
- [Create new affiliation](https://docs.rinne.com.br/api-reference/company-affiliations/create-new-affiliation.md): Creates a new affiliation for the authenticated company. The company_id is automatically set from the authenticated client. Requires the affiliation.create permission.
- [Get a specific affiliation](https://docs.rinne.com.br/api-reference/company-affiliations/get-a-specific-affiliation.md): Get details of a specific affiliation belonging to the authenticated company
- [Update affiliation anticipation configuration](https://docs.rinne.com.br/api-reference/company-affiliations/update-affiliation-anticipation-configuration.md): Requires the affiliation.edit permission.
- [Get onboarding document with download URL](https://docs.rinne.com.br/api-reference/company-affiliations/get-onboarding-document-with-download-url.md): Retrieves a single onboarding document with a signed download URL for an affiliation belonging to the authenticated company. The signed URL expires after 1 hour. Use this endpoint to download onboarding documents that were uploaded during the KYC/onboarding process.
- [Request settlement bank account update](https://docs.rinne.com.br/api-reference/company-affiliations/request-settlement-bank-account-update.md): Creates a new pending settlement bank account for an affiliation. Triggers a call to the payment provider to initiate bank account validation. The new account starts with PENDING_VALIDATION status; the current ACTIVE account continues to be used for card receivables settlements until validation comp…
- [Get transactions](https://docs.rinne.com.br/api-reference/company-transactions/get-transactions.md): Returns a paginated list of transactions for the authenticated company with optional filters. Requires the transaction.list permission.
- [Create a new transaction](https://docs.rinne.com.br/api-reference/company-transactions/create-a-new-transaction.md): Requires the transaction.create permission. Creates a new payment transaction. For PIX, supports dynamic QR code generation and provider integration.
- [Create a 3D Secure session](https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session.md): Creates a standalone 3D Secure (3DS) authentication session for a card payment in the authenticated company context. Requires the 3ds.create permission.
- [Authenticate a transaction with 3D Secure](https://docs.rinne.com.br/api-reference/3d-secure/authenticate-a-transaction-with-3d-secure.md): Authenticates a transaction that is in AWAITING_3DS status using a 3D Secure session. Links the authenticated session to the transaction, updates card data with 3DS authentication details (cryptogram, ECI, authentication_type), and processes the payment with the provider. Requires the transaction.cr…
- [Get transaction by ID](https://docs.rinne.com.br/api-reference/company-transactions/get-transaction-by-id.md): Returns a specific transaction by its ID (must belong to authenticated company). Requires the transaction.view permission.
- [Get transaction receipts](https://docs.rinne.com.br/api-reference/company-transactions/get-transaction-receipts.md): Requires the transaction.view permission.
- [Refund a transaction](https://docs.rinne.com.br/api-reference/company-transactions/refund-a-transaction.md): Requires the transaction.refund permission.
- [Cancel existing pending refund for a transaction by ID](https://docs.rinne.com.br/api-reference/company-transactions/cancel-existing-pending-refund-for-a-transaction-by-id.md): Requires the transaction.refund permission.
- [Cancel a BOLEPIX transaction](https://docs.rinne.com.br/api-reference/transactions/cancel-a-bolepix-transaction.md): Cancel a BOLEPIX transaction that is in WAITING_PAYMENT status. Only BOLEPIX payment method transactions can be cancelled. Requires the transaction.cancel permission.
- [Get company transactions overview](https://docs.rinne.com.br/api-reference/company-transactions/get-company-transactions-overview.md): Returns an overview of transactions for the authenticated company with aggregated statistics by status and a daily breakdown of successful transactions only (APPROVED, AUTHORIZED). Requires the transaction.list permission.
- [Pay organization's own PIX or BOLEPIX transaction via QR code (Sandbox Only)](https://docs.rinne.com.br/api-reference/transactions/pay-organizations-own-pix-or-bolepix-transaction-via-qr-code-sandbox-only.md): Processes a PIX payment using a QR code from a transaction owned by the authenticated organization company, for testing purposes. **This endpoint is only available in sandbox environment.**
- [Store a card](https://docs.rinne.com.br/api-reference/cards/store-a-card.md): Requires the card.create permission.
- [List stored cards](https://docs.rinne.com.br/api-reference/cards/list-stored-cards.md): Requires the card.list permission.
- [Get a stored card](https://docs.rinne.com.br/api-reference/cards/get-a-stored-card.md): Requires the card.view permission.
- [Delete a stored card](https://docs.rinne.com.br/api-reference/cards/delete-a-stored-card.md): Requires the card.delete permission.
- [Get account balance for a company](https://docs.rinne.com.br/api-reference/company-banking/get-account-balance-for-a-company.md): Retrieves the current company account balance in cents for a specific provider. Requires an active affiliation with the specified provider. Requires the banking.view permission.
- [Add balance to organization bank account (Sandbox Only)](https://docs.rinne.com.br/api-reference/banking/add-balance-to-organization-bank-account-sandbox-only.md): Adds balance to the authenticated organization's own bank account for testing purposes. **This endpoint is only available in sandbox environment.**
- [Get account statement (movements) for a company](https://docs.rinne.com.br/api-reference/company-banking/get-account-statement-movements-for-a-company.md): Retrieves the company account statement (movements) for a specific provider within a date range. Requires an active affiliation with the specified provider. Note: The provider enforces a maximum date range of 7 days and a maximum page size of 50. Requires the banking.view permission.
- [List all PIX keys](https://docs.rinne.com.br/api-reference/company-pix/list-all-pix-keys.md): Requires the pix.list permission.
- [Create a new PIX key](https://docs.rinne.com.br/api-reference/company-pix/create-a-new-pix-key.md): Requires the pix.create permission.
- [Delete a PIX key](https://docs.rinne.com.br/api-reference/company-pix/delete-a-pix-key.md): Requires the pix.delete permission.
- [Get a specific PIX key by ID](https://docs.rinne.com.br/api-reference/company-pix/get-a-specific-pix-key-by-id.md): Requires the pix.view permission.
- [List judicial blockages](https://docs.rinne.com.br/api-reference/company-banking/list-judicial-blockages.md): Returns a paginated list of judicial block/release movements for the authenticated company's bank accounts. Supports filtering by type, bank account, process number, and occurrence date range. Requires the banking.list permission.
- [List all company PIX keys](https://docs.rinne.com.br/api-reference/companies/list-all-company-pix-keys.md): Requires the banking.list permission.
- [Create a company PIX key](https://docs.rinne.com.br/api-reference/companies/create-a-company-pix-key.md): Requires the banking.create permission.
- [Get a company PIX key](https://docs.rinne.com.br/api-reference/companies/get-a-company-pix-key.md): Requires the banking.view permission.
- [Update a company PIX key](https://docs.rinne.com.br/api-reference/companies/update-a-company-pix-key.md): Requires the banking.edit permission.
- [Delete a company PIX key](https://docs.rinne.com.br/api-reference/companies/delete-a-company-pix-key.md): Requires the banking.delete permission.
- [List all bank accounts](https://docs.rinne.com.br/api-reference/companies/list-all-bank-accounts.md): Requires the banking.list permission.
- [Registers a new bank account](https://docs.rinne.com.br/api-reference/companies/registers-a-new-bank-account.md): Requires the banking.create permission.
- [Get specific bank account details](https://docs.rinne.com.br/api-reference/companies/get-specific-bank-account-details.md): Requires the banking.view permission.
- [Update bank account information](https://docs.rinne.com.br/api-reference/companies/update-bank-account-information.md): Requires the banking.edit permission.
- [Soft delete bank account](https://docs.rinne.com.br/api-reference/companies/soft-delete-bank-account.md): Requires the banking.delete permission.
- [Create a new cashout request](https://docs.rinne.com.br/api-reference/company-banking/create-a-new-cashout-request.md): Creates a new cashout request for the authenticated company. The cashout will be processed by the provider and status updates will be received via webhooks. Requires the banking.create permission.
- [List cashouts](https://docs.rinne.com.br/api-reference/company-banking/list-cashouts.md): Returns a paginated list of cashouts for the authenticated company. Supports filtering by status, method, and date range. Requires the banking.list permission.
- [Get a specific cashout by ID](https://docs.rinne.com.br/api-reference/company-banking/get-a-specific-cashout-by-id.md): Returns details of a specific cashout for the authenticated company. The cashout ID can be either the internal ID or the external request ID. Requires the banking.view permission.
- [Get cashout receipt](https://docs.rinne.com.br/api-reference/company-banking/get-cashout-receipt.md): Generates a receipt for a cashout operation. Returns JSON with cashout details, account information, and a base64-encoded PDF. Only available for cashouts with status COMPLETED, PARTIALLY_RETURNED, or RETURNED. Requires the cashout to have an end-to-end ID.
- [Get ledger entries](https://docs.rinne.com.br/api-reference/company-ledger/get-ledger-entries.md): Requires the ledger.list permission.
- [Get a single ledger entry by ID](https://docs.rinne.com.br/api-reference/company-ledger/get-a-single-ledger-entry-by-id.md): Requires the ledger.view permission.
- [User login with password](https://docs.rinne.com.br/api-reference/authentication/user-login-with-password.md): Authenticates user with email/phone and password. Returns JWT token. If user has multiple companies, returns available companies for selection. If user has single company, automatically selects it for optimal UX.
- [Select company context](https://docs.rinne.com.br/api-reference/authentication/select-company-context.md): Selects company context for authenticated user and returns new JWT token  with company-specific permissions. Used after login when user has multiple companies.
- [Get current user information](https://docs.rinne.com.br/api-reference/authentication/get-current-user-information.md): Returns information about the currently authenticated user based on JWT token. Includes user identifiers, auth methods, and current company context if set.
- [User logout](https://docs.rinne.com.br/api-reference/authentication/user-logout.md): Logs out the authenticated user by invalidating their JWT token. Note: JWT tokens are stateless, so they will continue to be valid until expiration. Future implementation will include token blacklisting for immediate invalidation.
- [Change current password](https://docs.rinne.com.br/api-reference/authentication/change-current-password.md): Changes the authenticated user's password. Requires current password for verification. User must be authenticated with a valid JWT token.
- [List users](https://docs.rinne.com.br/api-reference/users/list-users.md): Returns a paginated, organization-scoped list of users. Supports sorting by creation time.
- [Create a new user](https://docs.rinne.com.br/api-reference/users/create-a-new-user.md): Creates a new user with the provided identifiers and authentication methods. All identifiers start as unverified - user must complete verification flow. This endpoint requires authentication and the user.create permission.
- [Get user by ID](https://docs.rinne.com.br/api-reference/users/get-user-by-id.md): Retrieves detailed information about a specific user by their ID. Requires the user.view permission.
- [Update user information](https://docs.rinne.com.br/api-reference/users/update-user-information.md): Updates user information such as first name, last name, roles and metadata. Requires the user.edit permission.
- [Suspend user](https://docs.rinne.com.br/api-reference/users/suspend-user.md): Suspends a user. Requires the user.edit permission.
- [Activate user](https://docs.rinne.com.br/api-reference/users/activate-user.md): Activates a user. Requires the user.edit permission.
- [List roles](https://docs.rinne.com.br/api-reference/roles/list-roles.md): Returns a paginated list of roles with optional filters. Requires the role.list permission.
- [Create a new role](https://docs.rinne.com.br/api-reference/roles/create-a-new-role.md): Creates a new role with the provided name, permissions, and optional description
- [Get role by ID](https://docs.rinne.com.br/api-reference/roles/get-role-by-id.md): Returns a specific role by its ID. Requires the role.list permission.
- [Update role](https://docs.rinne.com.br/api-reference/roles/update-role.md): Updates a specific role with provided fields. Requires the role.edit permission.
- [Delete role](https://docs.rinne.com.br/api-reference/roles/delete-role.md): Deletes a specific role
- [Get all available permissions](https://docs.rinne.com.br/api-reference/permissions/get-all-available-permissions.md): Returns a list of all permissions available in the system with their description keys
- [Create an API key](https://docs.rinne.com.br/api-reference/api-keys/create-an-api-key.md): Requires the api_key.create permission and JWT (dashboard) authentication — API-key authentication is rejected on key-management endpoints.
- [List API keys](https://docs.rinne.com.br/api-reference/api-keys/list-api-keys.md): Requires the api_key.list permission and JWT (dashboard) authentication — API-key authentication is rejected on key-management endpoints.
- [Revoke an API key](https://docs.rinne.com.br/api-reference/api-keys/revoke-an-api-key.md): Requires the api_key.delete permission and JWT (dashboard) authentication — API-key authentication is rejected on key-management endpoints.
- [Create an API key for a merchant](https://docs.rinne.com.br/api-reference/api-keys/create-an-api-key-for-a-merchant.md): Requires the api_key.create permission and JWT (dashboard) authentication — API-key authentication is rejected on key-management endpoints.
- [List API keys of a merchant](https://docs.rinne.com.br/api-reference/api-keys/list-api-keys-of-a-merchant.md): Requires the api_key.list permission and JWT (dashboard) authentication — API-key authentication is rejected on key-management endpoints.
- [Revoke an API key of a merchant](https://docs.rinne.com.br/api-reference/api-keys/revoke-an-api-key-of-a-merchant.md): Requires the api_key.delete permission and JWT (dashboard) authentication — API-key authentication is rejected on key-management endpoints.
- [API health status](https://docs.rinne.com.br/api-reference/system/api-health-status.md): Returns the API health status, database, and payment providers
- [Get zipcode information](https://docs.rinne.com.br/api-reference/zipcode/get-zipcode-information.md): Retrieves address information for a given zipcode using external service

## OpenAPI Specs

- [api-spec](https://docs.rinne.com.br/api-spec.yaml)
- [openapi](https://docs.rinne.com.br/api-reference/openapi.json)