Changelog

The official public API Elixir SDK is available on Hex as the raims package.

If Hex is not installed yet, install it once:

mix local.hex

From your application project, check the current stable version's configuration:

mix hex.info raims

Copy the Config: line into the dependency list in deps/0 in mix.exs. Then fetch the dependencies and compile:

mix deps.get
mix compile

The SDK requires Elixir 1.18 or later with Erlang/OTP 27 or later and provides resource modules, response models, cursor pagination, and webhook verification. The Raims modules stay the same if you installed the SDK from GitHub.

To migrate a Git or local dependency, replace the previous declaration with the current Hex configuration and run mix deps.update raims. Review and keep mix.lock and test your integration before updating the application.

Keep your API key in the backend. The validated credential continues to determine company, environment, and permissions. Read the Elixir SDK guide to install, configure the client, and receive webhooks.

The official public API Java SDK is available on Maven Central as com.raims:raims-java. Add the dependency through Maven or Gradle to resolve the SDK and its dependencies when building your application.

The SDK requires Java 11 or later and provides typed builders and responses, cursor pagination, and webhook authentication. The coordinates stay the same if you installed the JAR with its POM from GitHub. Update the dependency version to the current stable version on Maven Central and test the flows used by your integration.

Keep your API key in the backend. The validated credential continues to determine company, environment, and permissions.

Read the Java SDK guide to install through Maven or Gradle, configure the client, and receive webhooks.

The official public API Node.js and TypeScript SDK is available on npm as the @raimshq/raims package. Install it from your application directory:

npm install @raimshq/raims

The SDK requires Node.js 22 or later and includes ESM and CommonJS modules, TypeScript declarations, cursor pagination, and webhook authentication. Keep your API key in the backend. The validated credential continues to determine company, environment, and permissions.

To update to the current stable version, use npm install @raimshq/raims@latest and test the flows used by your integration.

If you used an earlier TGZ, replace the dependency and imports with the new package name.

Read the Node.js SDK guide to configure the client, integrate resources, and receive webhooks.

The official public API Python SDK is available on PyPI as the raims package. Install it in your application's virtual environment:

python -m pip install raims

The SDK requires Python 3.10 or later and includes synchronous and asynchronous clients, typed parameters, cursor pagination, and webhook authentication. Keep your API key in the backend. The validated credential continues to determine company, environment, and permissions.

To update to the current stable version, use python -m pip install --upgrade raims and test the flows used by your integration. The raims import stays the same if you installed from GitHub; update the dependency source if your application pins a Git URL or local wheel.

Read the Python SDK guide to configure the client, integrate resources, and receive webhooks.

The official public API Ruby SDK is available on RubyGems as the raims gem. Install it in your application's environment:

gem install raims

The SDK requires Ruby 3.3 or later and provides resource services, typed responses, cursor pagination, and webhook verification. The require 'raims' statement stays the same if you installed the gem from GitHub.

For applications using Bundler, add gem 'raims' to Gemfile and run bundle install. To update an existing dependency, use bundle update raims; for installations managed directly through RubyGems, use gem update raims. Test the flows used by your integration before updating the application.

Keep your API key in the backend. The validated credential continues to determine company, environment, and permissions. Read the Ruby SDK guide to install, configure the client, and receive webhooks.

The official public API Rust SDK is available on crates.io as the raims crate. From your application project:

cargo add raims
cargo add tokio --features macros,rt-multi-thread

The SDK requires Rust 1.90 or later and a Tokio runtime. It provides typed services and responses, cursor pagination, and webhook verification for asynchronous backend integrations.

Cargo records resolved versions in Cargo.lock. Keep that file and run cargo update -p raims to update within the declared requirement. Read the guide to refresh that requirement with the current stable version or migrate a Git or local dependency. Test your integration before updating the application.

Keep the API key in your backend. The validated credential still determines company, environment, and permissions. Read the Rust SDK guide to install, configure the client, and receive webhooks.

API keys let you select individual actions, such as viewing customers, creating charges, revoking them, and requesting refunds. Granting one action does not select the others automatically. You can edit permissions without replacing the secret, and each item has a description and a Learn more link.

In Authorized applications, consent and permission editing use the same individual choices. Editing lets you remove and restore access from the original authorization; other operations require new consent. Account rules and the current permissions of the person who authorized access still apply.

Creating a key requires identity confirmation before opening the form when there is no valid authorization. That authorization is reused when creating the key while it remains accepted. If confirmation is needed again when saving, creation continues with the completed form without another click. Employees can copy a Sandbox secret or rotate a key only when their access covers all actions granted to it.

Raims CLI 0.1.4 and the documentation console also align environment selection with the authentication method. With an API key, the key determines the company and environment. With OAuth, the operation must accept the requested environment and the connection must authorize it. In the CLI, --environment is exclusive to OAuth; simulations remain restricted to Sandbox.

To update the CLI through npm, run npm install -g @raimshq/cli@latest. See API keys, Authorized applications, and Authentication to review your integration's access.

The official public API Delphi SDK is available as source code on GitHub. It provides services, parameters, and response models for backend use, with pagination and webhook signature verification.

The Delphi SDK guide explains adding src to Search path or Library path, platform requirements, and ownership of returned objects. Compile the units on your application's target and check its requirements. Keep the API key in your backend, outside binaries distributed to customers.

The official public API Elixir SDK is available on GitHub. Applications using Elixir 1.18 or later and Erlang/OTP 27 or later can add it as a Mix Git dependency, with the selected revision recorded in mix.lock.

The Elixir SDK guide covers installation, client setup, charge creation, pagination, and webhook verification. Keep the key in your backend; it determines the integration's environment, and financial simulations require a Sandbox key.

The official Go SDK connects server applications to the Raims public API through the github.com/raimshq/raims-go module. It requires Go 1.26.5 or later and provides typed services and responses, cursor pagination, and webhook authentication.

go get github.com/raimshq/raims-go@latest

Keep the API key in the backend. The validated credential continues to determine company, environment, and permissions, with the API idempotency and pending-result rules.

See the Go SDK guide to install, configure, and start the integration.

The official public API Java SDK is available in GitHub releases, with a JAR, POM, sources, and Javadoc. It requires Java 11 or later and provides typed builders and responses, cursor pagination, and webhook authentication. Download the current release artifacts before installing the JAR with its POM:

mvn install:install-file -Dfile=raims-java-release/raims-java.jar -DpomFile=raims-java-release/raims-java.pom

Keep the API key in the backend. The validated credential continues to determine company, environment, and permissions, with the API idempotency and pending-result rules.

See the Java SDK guide to install, configure, and start the integration.

The official public API Node.js SDK is available as the raims package, with ESM and CommonJS modules and TypeScript declarations. It requires Node.js 22 or later and provides resource services, cursor pagination, and webhook authentication. Download raims-node.tgz from the current stable release before installing:

npm install ./raims-node-release/raims-node.tgz

Keep the API key in the backend. The validated credential continues to determine company, environment, and permissions, with the API idempotency and pending-result rules.

See the Node.js SDK guide to install, configure, and start the integration.

The official public API Python SDK is available in GitHub releases, with a wheel that can be installed through pip. It requires Python 3.10 or later and provides synchronous and asynchronous clients, typed responses, cursor pagination, and webhook authentication.

Keep the API key in the backend. The validated credential continues to determine company, environment, and permissions, with the API idempotency and pending-result rules.

See the Python SDK guide to install, configure, and start the integration.

The official public API Ruby SDK is available through GitHub releases, with a gem for local installation. It requires Ruby 3.3 or later and provides resource services, typed responses, cursor pagination, and webhook verification.

See the Ruby SDK guide to download, install, configure credentials, and update the integration. Keep the API key in your backend; the validated credential still determines company, environment, and permissions.

The official public API Rust SDK is available on GitHub, with source and a .crate archive. Integrations use Rust 1.90 or later and Tokio; Cargo can resolve the Git dependency and record its revision in Cargo.lock.

See the Rust SDK guide to install, configure the client, and use typed parameters, pagination, and webhooks. Keep the key in your backend. The API's idempotency rules and pending results still apply.

Raims CLI 0.1.3 lets you connect your account through the browser with OAuth. API key profiles remain available for scripts and automation.

To install or update through npm, run npm install -g @raimshq/cli@latest. Then choose a profile and the environment to access:

raims login --profile pessoal --environment sandbox

The browser opens the Raims sign-in and consent pages. Check the account, choose the permissions, and complete the security confirmation when prompted. Tokens are encrypted, with protection from your operating system's native vault.

Raims MCP connects compatible AI applications to your account through https://mcp.raims.com, with OAuth and access to authorized operations. You do not need to copy an API key. For each data query or change, the application selects an environment allowed by the connection.

In Integration / Authorized applications, you can view the connections your profile may see, edit access you are allowed to manage, and revoke access. The person's and account's current permissions continue to limit operations. The connection does not require another authorization screen for every task.

See CLI configuration, Connect an MCP application, Authorized applications, and Account context to check the account and environment before using the granted access.

Raims CLI 0.1.2 includes a native Windows ARM64 executable through npm and direct installation.

To install or update through npm, use Node.js 22 or later for ARM64 and run npm install -g @raimshq/cli@latest. npm selects the executable using the Node.js architecture. The direct Windows ARM64 installer does not require Node.js and shows a plan before applying the installation with -apply.

Direct installations keep the selected architecture when running the CLI and updating its versions.

See Install with npm, Direct installation, and Check the architecture.

Raims CLI 0.1.1 provides installers for Windows x64, Linux (x64 and ARM64), and macOS (x64 and ARM64). Direct installation uses a user directory and lets you run the CLI by its full path without Node.js or npm.

The installer shows a plan by default and only applies the installation with -apply. The 0.1.1 installer selects the latest stable patch in the 0.1 line. To install through npm, including CI, use npm install -g @raimshq/cli@latest.

In a direct installation, an update can be downloaded silently and activated on the next eligible invocation. The running command keeps its version. You can disable updates or require an available version; preserve cached versions and backups.

raims licenses shows the notices and licenses included in the running version without a profile or network access. raims licenses --output json returns the text and its SHA-256 hash.

See Direct installation, CI and automation, and Notices and licenses.

Raims CLI is available on npm as the @raimshq/cli package. The initial release is version 0.1.0. You can also install this package with Yarn Classic, pnpm, or Bun. The installation guide lists the commands and explains how to run the CLI on demand with Yarn 2 or later. It requires Node.js 22 or later and provides packages for Windows x64, Linux (x64 and ARM64), and macOS (x64 and ARM64).

npm install -g @raimshq/cli@latest
raims version

Use the commands to query and manage public API resources in your terminal or scripts. Configure a profile with the name of the environment variable that contains your API key. The profile does not store the key's value; the validated credential determines the company, environment, and permissions.

Update through the same package manager you used to install it. The CLI does not automatically replace the version maintained by that manager. With npm:

npm install -g @raimshq/cli@latest

See the Raims CLI guide to install and configure profiles, and the command reference to choose the options for your integration.

The official public API PHP SDK can be installed through Composer as the raims/raims-php package. It requires PHP 8.2 or later on a 64-bit platform and provides resource services, typed responses, cursor pagination, and webhook signature verification.

composer require raims/raims-php

Use the API key in the integration backend. The validated credential continues to determine company, environment, and permissions; the API's pending responses and idempotency rules still apply.

See the PHP SDK guide to install, configure, and start the integration.

The changelog brings together new features, improvements, and fixes across Raims products. Each post includes the date and description of the change, with links to the documentation for the products involved.

Check each product's guides for its current conditions of use.

In the changelog, filter updates by product or product group. Each post has its own link with the date and full description of the change. Use pagination to browse earlier posts.

The official public API .NET SDK is available on NuGet as the Raims package. It supports x64 applications on .NET Framework 4.8/4.8.1 and .NET 10, with resource services, typed responses, pagination, and webhook verification.

dotnet add package Raims

Keep the API key in the integration backend. The validated credential still determines company, environment, and permissions; the API's pending results and idempotency rules remain applicable.

See the .NET SDK guide to install, configure, and start the integration.