Get to know Asaas Checkout

Asaas Checkout provides a hosted page for the payer to complete a purchase with Pix or credit card.

Use it when your application already has a purchase flow but you don't want to implement the payment interface.

When to use

Use Asaas Checkout when you need to:

• accept Pix, credit card, or both;
• create one-off, installment, or recurring payments;
• redirect the payer to a page hosted by Asaas;
• return the payer to your application after completion, cancellation, or expiration;
• use Payment Split;
• pre-fill customer data, when available.

Choose the flow

How Checkout is configured

Two settings define the main flow:

Some features require additional settings:

• subscription for RECURRENT;
• installment for INSTALLMENT;
• splits when using Payment Split;
• customer or customerData when your application wants to pre-fill the payer's data;
• callback to define the return URLs;
• minutesToExpire to control the Checkout's validity.

The complete fields, limits, and dependencies are in the Checkout creation reference.

How it works

%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
  A["Create the order"] --> B["Create the Checkout"]
  B --> C["Store the ID"]
  C --> D["Build the link"]
  D --> E["Redirect the payer"]
  E --> F["Payer completes the journey"]
  F --> G["Receive the Webhook"]
  G --> H["Update the order"]

  classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px,font-size:17px
  classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px,font-size:17px
  classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px,font-size:17px

  class A inicio
  class B,C,D,E,F,G validacao
  class H sucesso

  linkStyle default stroke:#94A3B8,stroke-width:2px

Creating the Checkout returns its id. Use this identifier to build the URL that will be made available to the payer.

See how to build the Checkout link.

Track the result via Webhook

Creating the Checkout does not confirm the payment.

Track its lifecycle through the events:

• CHECKOUT_CREATED;
• CHECKOUT_PAID;
• CHECKOUT_CANCELED;
• CHECKOUT_EXPIRED.

See the Events for Checkout.

Webhooks use at least once delivery. Process events idempotently using the event id.

Next steps

• Implement Checkout for Pix
• Implement Checkout for Credit Card
• Set up a recurring Checkout
• Set up Payment Split
• Set up the link and redirection
• Track the Events for Checkout

• Set an expiration time compatible with the payer's journey.
• Test in Sandbox first before releasing the checkout to production.

Related content

• Create new checkout
• Cancel a checkout
• Receive Asaas events at your Webhook endpoint
• Webhook events