# Rinne API

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

## Docs

- [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…
- [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…
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Initiate password recovery](https://docs.rinne.com.br/api-reference/authentication/initiate-password-recovery.md): Sends a verification code to the user's verified email address for password recovery. Returns the same response regardless of whether the identifier exists for security.
- [Resend verification code](https://docs.rinne.com.br/api-reference/authentication/resend-verification-code.md): Generates and sends a new verification code for the specified identifier. Used when previous code expired or wasn't received.
- [Reset password with verification code](https://docs.rinne.com.br/api-reference/authentication/reset-password-with-verification-code.md): Resets user password using the verification code sent during forgot password flow. Validates the code and sets the new password.
- [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.
- [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.
- [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.
- [Verify identifier code and set password](https://docs.rinne.com.br/api-reference/authentication/verify-identifier-code-and-set-password.md): Validates verification code and completes first access flow by setting user password. This endpoint is used for initial user setup after admin-created accounts.
- [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
- [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
- [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
- [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
- [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.**
- [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.**
- [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
- [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…
- [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 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.
- [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
- [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
- [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…
- [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
- [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 authenticated company information](https://docs.rinne.com.br/api-reference/companies/get-authenticated-company-information.md): Requires the company.list 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.
- [List all bank accounts](https://docs.rinne.com.br/api-reference/companies/list-all-bank-accounts.md): Requires the banking.list permission.
- [List all MCCs](https://docs.rinne.com.br/api-reference/companies/list-all-mccs.md): Requires the company.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.
- [Soft delete bank account](https://docs.rinne.com.br/api-reference/companies/soft-delete-bank-account.md): Requires the banking.delete permission.
- [Update authenticated company](https://docs.rinne.com.br/api-reference/companies/update-authenticated-company.md): Requires the company.edit permission.
- [Update bank account information](https://docs.rinne.com.br/api-reference/companies/update-bank-account-information.md): Requires the banking.edit 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
- [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.
- [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 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.
- [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 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.
- [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.
- [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.
- [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 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.
- [Get ledger entries](https://docs.rinne.com.br/api-reference/company-ledger/get-ledger-entries.md): Requires the ledger.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 all PIX keys](https://docs.rinne.com.br/api-reference/company-pix/list-all-pix-keys.md): Requires the pix.list 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.
- [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.
- [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.
- [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.
- [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.
- [Refund a transaction](https://docs.rinne.com.br/api-reference/company-transactions/refund-a-transaction.md): Requires the transaction.refund 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).
- [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.
- [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.
- [API Reference](https://docs.rinne.com.br/api-reference/introduction.md): Complete reference for the Rinne API
- [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.
- [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.
- [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.
- [Get merchant overview](https://docs.rinne.com.br/api-reference/management/get-merchant-overview.md): Requires the merchant.company.list 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.
- [List merchants](https://docs.rinne.com.br/api-reference/management/list-merchants.md): Requires the merchant.company.list permission.
- [Update merchant](https://docs.rinne.com.br/api-reference/management/update-merchant.md): Requires the merchant.company.edit permission.
- [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 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.
- [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 fee policy](https://docs.rinne.com.br/api-reference/pricing/create-a-new-fee-policy.md): Requires the fee_policy.create permission.
- [List cost policies](https://docs.rinne.com.br/api-reference/pricing/list-cost-policies.md): Requires the cost_policy.list permission.
- [List fee policies](https://docs.rinne.com.br/api-reference/pricing/list-fee-policies.md): Requires the fee_policy.list 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.
- [Update a fee policy](https://docs.rinne.com.br/api-reference/pricing/update-a-fee-policy.md): Requires the fee_policy.edit 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
- [Delete role](https://docs.rinne.com.br/api-reference/roles/delete-role.md): Deletes a specific role
- [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.
- [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.
- [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.
- [API health status](https://docs.rinne.com.br/api-reference/system/api-health-status.md): Returns the API health status, database, and payment providers
- [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.
- [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.
- [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.
- [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.
- [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 merchant transactions overview](https://docs.rinne.com.br/api-reference/transactions/get-merchant-transactions-overview.md): Requires the merchant.transaction.list 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.
- [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.**
- [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.**
- [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.
- [Activate user](https://docs.rinne.com.br/api-reference/users/activate-user.md): Activates a user. Requires the user.edit permission.
- [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.
- [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.
- [Suspend user](https://docs.rinne.com.br/api-reference/users/suspend-user.md): Suspends a user. Requires the user.edit 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.
- [Get webhook dashboard URL](https://docs.rinne.com.br/api-reference/webhooks/get-webhook-dashboard-url.md): Requires the webhook.list permission.
- [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
- [Affiliations](https://docs.rinne.com.br/concepts/affiliations.md): Connect merchants to payment providers for transaction processing
- [Banking](https://docs.rinne.com.br/concepts/banking.md): Manage bank accounts, balances, and transfers
- [Ledger entries](https://docs.rinne.com.br/concepts/ledger-entries.md): Understanding Rinne's double-entry accounting system for tracking all monetary movements
- [Organizations and merchants](https://docs.rinne.com.br/concepts/organizations-and-merchants.md): Understand the company hierarchy in Rinne's B2B2B model
- [PIX keys](https://docs.rinne.com.br/concepts/pix-keys.md): Manage PIX keys for receiving instant payments
- [Pricing](https://docs.rinne.com.br/concepts/pricing.md): Flexible rule-based pricing for fees and costs
- [Settlement items](https://docs.rinne.com.br/concepts/settlement-items.md): Understanding how Rinne tracks actual money movements and settles ledger entries
- [Transactions](https://docs.rinne.com.br/concepts/transactions.md): Process and manage payment transactions
- [Authentication](https://docs.rinne.com.br/guides/authentication.md): Learn how to authenticate with the Rinne API
- [Card transactions](https://docs.rinne.com.br/guides/card-transactions.md): Implement credit and debit card transaction flows, challenge strategy flags, and 3DS transitions.
- [Error handling](https://docs.rinne.com.br/guides/error-handling.md): Understand and handle API errors
- [PIX payments](https://docs.rinne.com.br/guides/pix-payments.md): Process instant payments using Brazil's PIX system
- [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.
- [User management](https://docs.rinne.com.br/guides/user-management.md): Manage users, roles, and permissions
- [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.
- [Webhooks](https://docs.rinne.com.br/guides/webhooks.md): Receive real-time event notifications from Rinne
- [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
- [Card Element](https://docs.rinne.com.br/rinne-js/card-element.md): Collect encrypted card data with validation state, field events, and theme customization.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Quickstart](https://docs.rinne.com.br/rinne-js/quickstart.md): Accept wallet and card payments with 3D Secure using rinne-js.
- [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.
- [3D Secure Element](https://docs.rinne.com.br/rinne-js/three-d-secure-element.md): Run 3DS authentication challenges and handle success, failure, and retry flows.
- [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.

## OpenAPI Specs

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