Account information and customization

Retrieve the branch and financial account number for your company at Raims. You can also check the commercial terms to estimate receipt costs in your integration and configure the images, colors, and support contact shown in the checkout.

Retrieve the account number

Use Retrieve the account number, with GET /v1/accounts/account_number, to get agency and account for your company's financial account. The request uses the company identified by the API key and accepts no parameters or body.

This request requires a Production key and an approved, enabled financial account. Sandbox has no financial branch or account number and returns 403 DATA_ENVIRONMENT_NOT_SUPPORTED. The console in this documentation accepts only Sandbox keys; retrieve the details from your integration's server, without entering a Production key in the documentation or browser.

If the account is not approved and enabled, or its details are unavailable, the response is 404 ACCOUNT_NUMBER_NOT_AVAILABLE. Check the account's status in the Dashboard before trying again.

Keep the branch and account as text, including leading zeros and the returned formatting. The request does not register an account or change the destination of withdrawals.

Retrieve account fees

Use Retrieve account fees, with GET /v1/accounts/fees. The response contains the current Pix and boleto fee rules in the plan selected by the company.

The request does not change the plan or fees. Current values also do not indicate which fee applied to a past transaction. To check a fee already charged, retrieve the entries in the Statement.

Understand the values

Each payment method returns its configured percentage component, fixed amount, and fee limits:

A value of 85 in a cents field represents R$ 0.85. A null field indicates that the component or limit is not configured. Both percentage and fixed components can be present in the same rule.

If pix or boleto is null, there is no current rule for that method in the selected plan. This does not mean that receiving payments is free. The presence of a rule also does not confirm that the method is enabled to receive payments.

Checkout customization

Use Retrieve checkout customization to check the company's images, colors, support email, and default payment methods in the key's environment. Sandbox and Production have separate settings; changing one environment preserves the other's settings.

To change the colors or contact, use Update checkout customization. Send hex_primary_color for the primary color and hex_secondary_color for the background color, in #RRGGBB format. Omitting a field keeps its value. In support_email, null or empty text removes the support contact. Colors must retain valid values. An empty body keeps the current settings.

payment_method_types identifies the default methods enabled and available for the checkout. Updating through the API does not change this list. To choose Pix and boleto, use

Account, Settings, Payment checkout.

The account's default methods apply when the charge and link have no settings of their own. Changing this default may change the options on charges that use it. A charge's own list continues to apply; the link can restrict those options. See Checkout and payment methods.

These preferences do not change a charge's amount, due date, or status, and do not confirm payment. The request returns the current settings; it does not show the appearance used on a past date.

Checkout logo and icon

Uploading each image has three steps:

1. Use Prepare a logo upload or Prepare an icon upload. Send the file's type, size in bytes, width, and height. PNG and JPEG are accepted; the icon must be square. Check the limits in the corresponding endpoint's parameters.
2. Send the file bytes to upload_url with the PUT method. Set Content-Type and Content-Length according to content_type and file_size in the response. Do not send the Raims API key to this address. The URL is temporary. Complete the upload and association before expires_at, expressed in Unix seconds UTC.
3. Use Update checkout customization and send the returned id in logo_upload_id or favicon_upload_id. The two fields are independent. Use a logo upload in the logo field and an icon upload in the icon field, always for the same company and environment.

Getting the URL or completing the PUT does not change the image shown in the checkout. Association through PATCH may return 202 while the image is checked. Retrieve the settings to track logo.status and favicon.status:

url contains the current image or null when none is available. During processing or after a failure, the previous image remains in use, if one exists. The new image is used when the change finishes with status: ready.

If you need to repeat the PATCH while the image is being processed, use the same upload ID. An upload that failed or has already been replaced cannot be applied again. Prepare a new upload to replace the image again. When error_code has a value, check the reason:

Remove a checkout image

To remove an image, send logo_upload_id: null or favicon_upload_id: null. Omitting these fields keeps the current images. Removal can also require processing; it finishes with status: absent. You can also change this setting in the checkout appearance section of the Dashboard.

Discard an unused upload

If you abandon an upload before associating it, use Discard an image upload, with the same id returned when preparing it. Discarding also accepts an expired authorization. The deleted: true response confirms that the upload was discarded and can no longer be applied; repeating the request keeps this result. An upload already associated with the checkout cannot be discarded through this endpoint. To remove the image, use PATCH with the corresponding field set to null.

Company and environment

These requests identify the company through the API key. You do not need to send the company identifier in the request.

Fees are shared between Sandbox and Production. A Sandbox key retrieves the same rules for the company, while test payments remain separate from real transactions.

Protect the key on your integration's server. Handle errors using the HTTP status and error.code, as described in HTTP response codes.