Raims guides
Integration guides and guidance from the Learn more links in the Raims Dashboard.
Browse the integration guides and guidance linked from Learn more in the Raims Dashboard.
Documentation language
Use the Language button, between Status and the theme selector, to choose
Português (Brasil) or English (United States). The documentation keeps
the current page when you switch languages and saves your preference in this
browser.
Portuguese pages use /br/ and English pages use /en/.
If you are signed in to the Dashboard and have selected a language in your profile, choose Use account language in this menu to open the same page in that language. This option is unavailable without a connected session or when your profile preference is Automatic. You can still choose Português or English directly from the menu.
Opening a link preserves the language in its address. Switching languages in the documentation keeps the query parameters and page section and does not change your profile preference, company, or selected Dashboard environment.
Guides by area
Authentication
Set the Bearer header and choose the key for the company and environment.
API keys
Authentication, environments, secure storage, and IP restrictions.
Webhooks
Configuration, events, signatures, and protecting the secret.
Withdrawals
Available balance, destination account, limits, fees, and tracking.
Automatic withdrawals
Minimum amount, schedule, fee, and next run.
Payment methods
Pix, boleto, and the codes used in API charges.
Checkout
Default payment methods and checkout appearance.
Users and permissions
Invitations, team management, and the scope of each permission.
Availability for your access
Options depend on your permissions, the environment, and the account status.