Skip to main content

Multi-Method

In Multi-Method mode, Checkout receives more than one valid payment method in the method parameter (or ALL). In this scenario, Checkout displays a payment method selection step so the user can choose how to pay.

How it works in practice​

When the merchant sends multiple valid payment methods:

  1. A Checkout session is created with a Checkout ID.
  2. Checkout renders a method selection screen with the available options.
  3. The user selects one method and starts a payment attempt.
  4. The user can switch methods, and try again within the same session.
  5. The checkout is successful when the user completes a payment; the session status is updated accordingly.

In other words, in Multi-Method the user can choose and change payment methods during the same checkout session, while your backend keeps one session-level reference.

Endpoint example (multiple methods)​

Use the Checkout generation endpoint and send an array with valid payment methods in method:

POST https://api-sandbox.letpay.io/checkout/generate
curl --location 'https://api-sandbox.letpay.io/checkout/generate' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN' \
--data '{
    "contractId": "{{contractId}}",
    "referenceId": "{{$guid}}",
    "method": ["CREDITCARD","PIX","BOLETO"],
    "amount": "1.00",
    "asset":"BRL",
    "pixDirect": true,
    "paymentCountry": "BR",
    "paymentCurrency": "BRL",
    "successUrl": "{{successUrl}}",
    "saveCard": true,
    "notificationUrl": "Notification",
    "checkoutNotificationUrl":"{{checkoutNotificationUrl}}",
    "checkoutReferenceId":"{{checkoutReferenceId}}",
    "expiresIn": 60
}'

This request creates one checkout session with method selection enabled, allowing the customer to choose among the provided options.

End-user journey​

  • The user opens checkout and sees the list of available methods.
  • The user selects a method (e.g., PIX, CREDITCARD, BOLETO) and follows that method flow.
  • If the attempt is not completed, the user may choose another method and retry.
  • The checkout progresses from CREATED to PROCESSING, then to a final status (PAID, CANCELED, or ERROR).

Business decisioning with Checkout ID​

Use Checkout ID as the decision reference for product/service release:

  • PAID: release access, ship goods, or confirm the service.
  • CREATED/PROCESSING: keep the order pending.
  • CANCELED/ERROR: do not release and route the customer to a new attempt.

This approach is especially important in Multi-Method because multiple attempts can happen in one session; decisioning by session status is more reliable than decisioning by isolated attempts.

When to use Multi-Method​

Multi-Method is recommended when you want to maximize conversion by giving users payment choice and fallback options in the same session.

Use this flow when customer profile, device, or context may affect preferred payment method, or when you want to reduce drop-off after a failed first attempt.