Introduction - Payment Link
Get to know Payment Links
The Payment Link provides a page hosted by Asaas where the payer enters their details and completes the payment.
Use this feature when you don't want to register each customer in advance or build your own payment screen.
When to use
Use Payment Links when you need to:
- share the same payment page with different customers;
- let the payer enter their own details;
- work with a fixed amount or allow the payer to choose the amount;
- allow installments within the configured limit;
- offer a payment page hosted by Asaas.
What can be created
A Payment Link can generate different types of charges:
| Need | Type |
|---|---|
| One-time payment | DETACHED |
| Installment payment | INSTALLMENT |
| Recurring charge | RECURRENT |
Available payment methods include bank slip (boleto), Pix and credit card.
When billingType is UNDEFINED, the payer can choose among the payment methods available in the Link.
If value is not provided, the payer can define the amount at the time of payment.
The details of each configuration are in the Creating a payment link guide.
Payment Link or charge via API?
| Need | Charge via API | Payment Link |
|---|---|---|
| Create the charge for an already registered customer | ✓ | — |
| Let the payer enter their own details | — | ✓ |
| Allow an open amount | — | ✓ |
| Allow the payer to choose the number of installments | — | ✓ |
| Use a hosted page to collect the data | — | ✓ |
| Use Payment Split | ✓ | — |
Use Payments when your application needs to control the customer and charge data in advance.
Use Payment Links when this information can be filled in on the page hosted by Asaas.
How it works
%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
A["Create the Payment Link"] --> B["Receive the URL"]
B --> C["Share it with the payer"]
C --> D["Payer enters their details"]
D --> E["Asaas generates the charge"]
E --> F["Receive the Webhooks"]
F --> G["Reconcile the payment"]
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 validacao
class G sucesso
linkStyle default stroke:#94A3B8,stroke-width:2px
The generated charge has the paymentLink field, which lets you identify the originating Payment Link in payment events.
Prefer Webhooks to track the payment instead of periodically querying the API.
Related features
After creating the Payment Link, you can also:
- configure the payer's return to your application after payment;
- define notifications for the generated charges;
- track confirmation, due date, refund and other changes via Webhook.
ImportantRedirection only controls the payer's navigation. Do not use the return to confirm the payment.
Confirm the result through payment events.
Next steps
Updated 7 days ago
