> For the complete documentation index, see [llms.txt](https://docs.barte.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.barte.com/guias/passo-a-passo-do-vendedor/4o-casos-de-uso-fluxo-completo/links-de-pagamento/link-de-pagamento-recorrente.md).

# Link de Pagamento Recorrente

Este caso de uso descreve como um vendedor cria um **Link de Pagamento Recorrente** para contratação de uma **assinatura**, utilizando um checkout hospedado pela Barte.\
O cliente acessa o link, realiza a contratação e os pagamentos passam a ocorrer de forma recorrente, conforme o plano configurado.

***

### Atores

* **Vendedor (Seller)**: Sistema integrador
* **Comprador (Buyer)**: Cliente final que contratará a assinatura
* **Barte API**: Responsável pelo checkout, criação da assinatura, cobranças recorrentes e notificações

***

### Pré-condições

* O vendedor possui um **Token de API válido**
  * 📌 Referência: [Obtendo o Token de API](/guias/passo-a-passo-do-vendedor/1o-preparacao/obtendo-o-token-de-api.md)
* Um **Plano de Assinatura deve estar previamente criado** (**obrigatório**)
  * 📌 Referência: [Criando Plano de Assinatura](/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/assinaturas/criando-plano-de-assinatura.md)
* O vendedor definiu os **métodos de pagamento permitidos** no checkout
* O comprador **não precisa ser criado previamente**
  * O Buyer será criado automaticamente durante o checkout, se necessário

***

### Fluxo Principal

#### 1. Autenticação na API

Todas as requisições devem conter o Token de API no header:

```
X-Token-Api: YOUR_API_KEY
```

📌 Referência: [Obtendo o Token de API](/guias/passo-a-passo-do-vendedor/1o-preparacao/obtendo-o-token-de-api.md)

***

#### 2. Criar um Plano de Assinatura (Obrigatório)

O plano define as regras da cobrança recorrente, como:

* Periodicidade
* Valor
* Ciclo de cobrança

📌 O UUID do plano será utilizado obrigatoriamente na criação do link recorrente.

📌 Referência: [Criando Plano de Assinatura](/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/assinaturas/criando-plano-de-assinatura.md)

***

#### 3. Criar um Link de Pagamento Recorrente

Com o plano criado, o vendedor gera um link de pagamento recorrente.

Configuração importante:

* `type = SUBSCRIPTION`
* `paymentSubscription.idPlan` deve conter o UUID do plano
* Definição dos métodos de pagamento permitidos no checkout

Resultado esperado:

* A API retorna um **link público (url)** de checkout
* O link pode ser compartilhado livremente com o cliente

📌 Referência: [Link de Pagamento Recorrente](/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/links-de-pagamento/link-de-pagamento-recorrente.md)

***

#### 4. Cliente acessa o Link de Pagamento

Ao acessar o link:

* O cliente preenche seus dados
* Escolhe o método de pagamento disponível
* Confirma a contratação da assinatura

O que acontece:

* Um Buyer pode ser criado automaticamente
* A assinatura é criada conforme o plano
* A primeira cobrança é processada (quando aplicável)

***

### Fluxos Pós-Contratação

Após a criação da assinatura, o ciclo passa a ser gerenciado pela Barte.

#### Atualizações via webhook

Webhooks são enviados sempre que ocorrer:

* Criação da assinatura
* Pagamento confirmado
* Falha de pagamento
* Cancelamento
* Alteração de status

💡 Os webhooks de **Subscriptions** devem ser utilizados como **fonte de verdade** para o estado da assinatura.

***

### Pós-condições

Ao final deste caso de uso, o vendedor consegue:

* Criar um plano de assinatura
* Criar um link de pagamento recorrente
* Permitir que clientes contratem assinaturas via checkout Barte
* Acompanhar o ciclo da assinatura via webhooks
* Controlar cobranças recorrentes sem checkout próprio

***

### Observações Importantes

* O **plano de assinatura é obrigatório**
* O Buyer **não é obrigatório** antes da criação do link
* O link recorrente **não cria regras de cobrança**, apenas referencia um plano
* A confirmação da assinatura **não deve ser feita pelo frontend**
* Webhooks são a fonte de verdade do ciclo da assinatura


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.barte.com/guias/passo-a-passo-do-vendedor/4o-casos-de-uso-fluxo-completo/links-de-pagamento/link-de-pagamento-recorrente.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.