Payment methods
Learn about Raims payment methods and the codes used in API charges.
Raims offers Pix and boleto. Checkout shows the options allowed for the charge, subject to platform availability and the charge, link, and account settings. Credit and debit cards are disabled and are not offered for payment.
Pix and boleto
For Pix, the payer uses the QR Code or Pix copy-and-paste code shown at checkout. For boleto, they use the document or payment line provided. Issuing payment details does not confirm that the charge has been paid. Check the charge status to track confirmation.
To adjust the account defaults, see Checkout and payment methods.
API codes
When creating a charge, choose whether it uses the checkout configuration, has a custom list, or requests Pix or boleto issuance during creation:
| What you want to do | Payment method configuration | Effect |
|---|---|---|
| Use the checkout configuration | Omit payment_method_types or send null; omit payment_method or send 0. | The payer chooses from the methods enabled by the checkout configuration. Without a custom link configuration, the current account default applies, including later changes. |
| Set a list for this charge only | Send payment_method_types with [1], [2], or [1, 2]; omit payment_method or send 0. | The list overrides the account default for this charge. The method starts undefined, even with one option; issuance follows the selection at checkout. |
| Request Pix during creation | Send payment_method: 1, without a custom list. | Requests Pix issuance and allows only Pix. |
| Request boleto during creation | Send payment_method: 2, without a custom list. | Requests boleto issuance and allows only boleto. |
payment_method_types accepts numbers without duplicates: 1 for Pix and 2
for boleto. An empty list does not mean that the charge should use the checkout
configuration. Do not send 0, other codes, strings, booleans, or null items
in this list.
Respect the available options
The configuration remains subject to platform availability. A custom link list
can reduce the charge's options. Without a custom charge list,
payment_method: 1 or 2 does not enable a method disabled in the checkout
configuration or offer another method as an alternative. Do not combine a
populated payment_method_types list with payment_method: 1 or 2.
Configuration examples
The examples show only the payment method fields. Also include the other fields required by Create a charge.
Allows Pix and boleto for this charge, with payment_method omitted. The
list does not change the account default or request immediate issuance.
{ "payment_method_types": [1, 2] }Requests Pix during creation, without payment_method_types. Available
details appear in payment_information.pix.
{ "payment_method": 1 }Requests boleto during creation, without payment_method_types. Available
details appear in payment_information.boleto.
{ "payment_method": 2 }Pending issuance preserves the charge ID for tracking through individual retrieval. See Receive Pix details during creation and Receive boleto details during creation for customer data and address completion by postal code (CEP). None of these settings confirms payment.
Registered method and checkout selection
The following three fields describe different things when retrieving a charge:
| Field | What it reports | What you cannot conclude |
|---|---|---|
payment_method | The currently registered method: 0 undefined, 1 Pix, or 2 boleto. An undefined charge changes to 1 or 2 when generation is recorded. | The registered method alone does not confirm payment. |
payment_method_types | The custom list set during creation, or null when the charge uses the checkout configuration. | The list does not change to reflect the selected method and does not represent the options available at that time. |
checkout_payment_method | The method recorded at checkout, or null until that record exists. | Selecting an option on the screen alone does not confirm generation or payment. |
For example, a charge created with payment_method_types: [1, 2] keeps the
list after Pix generation is recorded. This retrieval excerpt shows the
current method and the original configuration:
{
"payment_method": 1,
"payment_method_types": [1, 2]
}For a charge created with payment_method: 0, recording Pix generation makes
retrieval report payment_method: 1 and checkout_payment_method: 1.
Setting payment_method: 1 during creation requests direct Pix issuance.
The payment_method filter in List charges considers the
currently registered method. Clicking an option at checkout without recording
generation does not make an undefined charge match the Pix or boleto filter.