Skip to main content

Single-Method

In Single-Method mode, Checkout receives only 1 valid payment method in the method parameter. In this scenario, there is no method selection step: the user is taken directly to the selected method flow.

How it works in practice​

When the merchant sends only one payment method:

  1. A Checkout session is created with a Checkout ID.
  2. Checkout renders the selected method screen directly (no method list).
  3. A payment attempt is initiated for that method as soon as the checkout session starts.
  4. The outcome of that attempt updates the status of the same Checkout ID.

In other words, in Single-Method the user does not choose how to pay; they only complete (or abandon) the flow for the method already defined by the merchant.

Endpoint example (single method)​

Use the Checkout generation endpoint and send only one payment method in method:

POST https://api-sandbox.epag.io/checkout/generate
curl --location 'https://api-sandbox.epag.io/checkout/generate' \
--header 'X-Auth-Token: MY_ACCESS_TOKEN' \
--data '{
	"amount": 10.00,
	"asset": "BRL",
	"referenceId": "MY_REFERENCE_ID",
	"contractId": "MY_CONTRACT_ID",
	"method": "PIX",
	"notificationUrl": "https://my.notification.url/callback/",
	"successUrl": "https://mysite.com/success",
	"declinedUrl": "https://mysite.com/declined",
	"errorUrl": "https://mysite.com/error"
}'

This request creates one checkout session and renders the selected method directly, without showing a method selection screen.

End-user journey​

  • The user opens checkout and immediately sees the configured method (e.g., PIX, CREDITCARD, BOLETO).
  • The user provides the required method data and confirms the payment.
  • 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 avoids decisions based on isolated events and keeps your fulfillment flow consistent.

When to use Single-Method​

Single-Method is recommended when you already know which method should be used (based on business rule, sales channel, or a guided experience).

If you want to increase flexibility and conversion by allowing customers to choose between multiple methods in the same session, use the Multi-Method flow.