Checkout and payment methods

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.

Charges created through an integration

The Create a charge request accepts a custom list in payment_method_types: [1] for Pix, [2] for boleto, or [1, 2] for both. This list overrides the account default for that charge only, subject to platform availability. A custom link configuration can reduce its options.

Omitting the list or sending null keeps the charge using the configuration applied by checkout. Without a custom list, payment_method: 0 lets the payer choose, while 1 or 2 restricts the charge to the specified method. With a populated list, omit payment_method or send 0. None of these options changes the account default.

Without a custom list, payment_method: 1 requests Pix and payment_method: 2 requests boleto during creation, with 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). A list such as payment_method_types: [1] or [2] keeps issuance after the selection at checkout. See Receive Pix details during creation and Receive boleto details during creation.

See Payment methods for the codes and the difference between the registered method and the checkout selection.

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

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. Go to Account, Settings, Payment checkout, Appearance with Edit checkout appearance.
2. 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.
3. Enter a Customer support email if you want to display a contact for your company at checkout.
4. Set the Main color and Background color in hexadecimal format. Use Restore default colors to return to the original palette.
5. Check the Checkout preview in mobile or desktop mode and select Save identity.

The preview lets you review the appearance; it does not create or pay a charge. Changes should be considered saved only after confirmation.

Guide someone who received a link

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.

When the link has a valid HTTPS Cancel URL accepted by Raims, checkout shows the Back to website arrow beside the brand. Selecting this arrow opens the address configured by the company. It does not cancel the charge, Pix, or boleto, and does not confirm payment.

Without a valid return address, the arrow does not appear. Closing the tab does not trigger this return automatically. The arrow appears during the checkout details and payment steps; it does not appear on a receipt or an invalid link.

With a valid HTTPS Success URL accepted by Raims, checkout may try to open that address automatically when it receives confirmation that the charge has been paid. This attempt requires the same open checkout to have been tracking the payment before confirmation and to remain valid for that tracking.

Raims allows at most one automatic attempt per charge, even when it is open in multiple tabs or devices. Reloading or reopening a paid charge and viewing the invoice or receipt directly do not start or repeat this return. If the payer chooses Back to website or views the invoice or receipt while waiting for the return, automatic navigation does not resume.

Generating Pix details, issuing a boleto, or showing a payment as processing does not confirm that the charge has been paid. Failure, cancellation, and refunds do not trigger this return either. Without a valid success URL, checkout does not use the cancel URL as an automatic destination.

The return attempt does not guarantee arrival at the website: closing the tab or losing the connection may interrupt navigation. Use the confirmed charge status to check payment; a visit to 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.