Docs
Checking Raims account

Checkout and payment methods

Understand how the account's default payment methods apply to checkout and how to configure its options.

The Learn more link appears in

Account, Settings, Payment checkout,

below the default payment methods.

Viewing this section requires View account settings. Edit checkout appearance and Edit payment methods control their respective changes. Options also depend on account availability.

Payment methods

The methods enabled in this section form the account default. Checkout uses this default when the charge and link have no custom payment method configuration. Changing the default also changes the options for those charges.

Custom link configuration

When a link is created with its own payment method configuration, that choice applies only to the link and does not change the account default. If the charge already has its own list, the link can only reduce its options.

Charges created through an integration

The configuration sent in Create a charge determines which options checkout can show:

Charge configurationEffect on checkout
Without a custom list, with payment_method omitted or payment_method: 0Uses the checkout configuration. Without a custom link configuration, the current account default applies.
With a custom payment_method_types listOverrides the account default for this charge; a link can only reduce its options. The method starts undefined, and issuance follows the selection at checkout.
Without a custom list, with payment_method: 1 or 2Requests Pix or boleto during creation and restricts the charge to that method, without enabling a disabled option.

With a custom list, omit payment_method or send 0. The configuration does not change the account default and remains subject to platform availability. See Payment methods to compare codes, configuration examples, and fields returned when retrieving a charge.

Issuance during creation makes the details available for the integrator to show to the payer. Boleto uses the customer record and can complete missing address fields from the postal code (CEP). The conditions are in Receive Pix details during creation and Receive boleto details during creation.

For customer registration, amount, due date, and optional email delivery of the link, see Charges.

Use create_checkout: true when creating the charge to receive its link in checkout_url, even without an email request or return URL. The link belongs to that charge. To obtain or configure the link for an existing charge, see Payment links.

The due date must be at least five minutes ahead of the current time when the API validates the request. Pix keeps the specified time; boleto uses the São Paulo date, including the same day. An expired checkout does not confirm the cancellation of a boleto already issued.

Change the defaults

  1. Open the Payment methods tab

    Go to Account, Settings, Payment checkout, Payment methods with Edit payment methods.

  2. Set Pix and boleto

    Enable or disable Pix and boleto to set the defaults you want. At least one available method must remain enabled. To disable the only active method, enable another one first.

  3. Save and confirm

    Select Save payment method and wait for the success message before closing the section.

Card may appear as Unavailable. A method shown in the interface should not be considered enabled for your operation when its control is disabled.

Change the appearance

  1. Open the Appearance tab

    Go to Account, Settings, Payment checkout, Appearance with Edit checkout appearance.

  2. Upload your brand and enter a contact

    Use Upload logo and Upload icon for your brand files. Follow the displayed formats, dimensions, and file size, and wait for the upload to finish. Enter a Customer support email if you want to display a contact for your company at checkout.

  3. Adjust the colors

    Set the Main color and Background color in hexadecimal format. Use Restore default colors to return to the original palette.

  4. Check the preview and save

    Check the Checkout preview in mobile or desktop mode and select Save identity. The preview does not create or pay a charge. Consider the changes saved only after confirmation.

The payer opens the link shared by the company and checks the charge details and available methods. For Pix, they use the QR Code or payment code shown; for boleto, they use the document or payment line provided. Confirmation depends on the status shown at checkout and on the charge.

Return to the website at the payer's choice

The Cancel URL is a valid HTTPS address accepted by Raims for returning to the company's website. When configured, checkout shows the Back to website arrow beside the brand during the details and payment steps.

SituationBehavior
The payer selects Back to websiteOpens the address configured by the company. It does not cancel the charge, Pix, or boleto and does not confirm payment.
There is no valid return addressThe arrow does not appear.
The payer closes the tabThe return does not happen automatically.
The payer is on a receipt or an invalid linkThe arrow does not appear.

Return after payment confirmation

With a valid HTTPS Success URL accepted by Raims, checkout may try to open that address when it receives payment confirmation. The tab that was already tracking the charge before confirmation must remain open and receive the charge's updated status. The return is attempted only while that tab is visible. If checkout reports that the link is unavailable, the return does not happen.

Raims allows at most one automatic attempt per charge, even when the charge is open in multiple tabs or devices.

SituationAutomatic return
The tab already tracking the charge receives confirmation and is visible when the return is attemptedMay try to open the valid success URL.
The payer reloads or reopens a paid charge, or views the invoice or receipt directlyDoes not start or repeat the return.
While waiting for the return, the payer chooses Back to website or views the invoice or receiptAutomatic navigation does not resume.
Only Pix generation, boleto issuance, or payment processing has occurredThere is no payment confirmation to trigger the return.
Failure, cancellation, or a refund occursDoes not trigger the return.
There is no valid success URLDoes not use the cancel URL as an automatic destination.

A website visit does not prove payment

Closing the tab or losing the connection may interrupt the return attempt. Check the confirmed charge status; arriving at the success URL does not replace that confirmation.

A Sandbox link indicates a test and must not be presented as a real payment. If checkout reports that the link was not found or is unavailable, check that you opened the full address sent by the company without changing any part of it. If the message persists, ask the company that issued the charge to check the link. The message does not explain why the link is unavailable and does not establish whether the link was paused, the charge was cancelled, or payment occurred.