Start here
Prepare your Sandbox credential and make your first request to the Raims API.
Before you test
The interactive console in this documentation accepts only Sandbox
credentials, which start with sk_test_.
To test, select or enter a Sandbox key. See API keys to create and protect your credential.
The API Reference brings together Raims endpoints, parameters, responses and code examples. The console lets you enter request data, send a test request and inspect its response on the same page.
Choose the language of the example and copy the request to adapt it to your system. Examples reflect the values entered in the fields.
To interpret resource codes and ID prefixes, see the types and identifiers map in Guides.
Base URL
The base URL of the Raims API is:
https://api.raims.comSandbox and Production use the same address. The credential sent in the request determines the environment.
API environments
Sandbox and Production belong to the same company, with separate data and credentials. The key identifies the company and environment of the request; these values are not selected in the request body.
| Environment | Credential prefix | Use |
|---|---|---|
| Sandbox | sk_test_ | Development, integration testing and tests in the documentation console, without moving real money. |
| Production | sk_live_ | Requests with real effects on the account, sent by your system outside the documentation console. |
Check the method and full address shown on each endpoint page. Use that address in tests and integration examples. Before using Production, check the credential and your application settings.
To test an approved payment or a failed charge without moving real money, use Simulation. These endpoints accept only Sandbox. Other requests remain on their respective resource pages and use the key for the test environment.
Authentication
See the Authentication guide to configure headers, choose the environment key and review integration access.
The API uses the Authorization header with the HTTP Bearer scheme:
Authorization: Bearer sk_test_...sk_test_... is only a placeholder. In the console, enter your full Sandbox
key in Credentials. The example builds the authentication header for you.
The key's configured IP restrictions also apply to tests. A source outside
the authorized ranges receives 403. See
IP restrictions before
changing this setting.
The console does not save your key in the browser. In your system, keep the secret on the server responsible for the integration and do not expose it in the browser, repositories or logs.
Using the console
- In the sidebar, choose the endpoint you want to test. Check its method, address and field rules.
- Select or enter a Sandbox credential in Credentials.
- Fill in the required fields and any optional data you want to send. Suggested placeholder values are not sent automatically. If a required field is missing, the console highlights it before sending.
- Choose the language to inspect the example, then select Try it.
- Check the HTTP status and body in the Response panel. The Responses section at the end of the page details the expected results.
To inspect an example without sending a request, expand a status in Responses. The Response panel shows the corresponding example when one is defined for the endpoint.
If the credential is invalid, correct the field before testing. If a warning about Production credentials appears, replace the key with a Sandbox credential.
See HTTP response codes for general errors, response formats and retry guidance. Even after an error or connection loss, the request may have been processed. Check the result before trying again.