> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciar parcerias de afiliados

> Consulte programas, acompanhe parceiros e encerre uma parceria pela API.

Uma parceria identifica **com quem sua organização pode dividir uma venda**. Ela não define o percentual e não movimenta dinheiro: a comissão de afiliado é incluída no pagamento conforme as [comissões de afiliados](https://docs.chargefy.io/payments/affiliate-fees.md).

Como exemplo ilustrativo, a Escola Lumen combina uma comissão de afiliado com Ana. O vínculo permite indicar a organização de Ana nas vendas da Escola. Só criar esse vínculo não transfere nenhum valor para Ana.

## Sua organização

Sua API key pode [listar as parcerias](https://docs.chargefy.io/api-reference/affiliations/list.md), [consultar uma parceria](https://docs.chargefy.io/api-reference/affiliations/get.md) e [encerrar uma parceria](https://docs.chargefy.io/api-reference/affiliations/delete.md). Não envie o header `Organization`.

| Consulta | O que retorna |
| - | - |
| `side=affiliates` | As organizações afiliadas ao seu programa |
| `side=programs` | Os programas dos quais sua organização participa |

A parceria só nasce quando a afiliada tem cadastro financeiro aprovado. No vínculo por convite, aceitar antes da aprovação deixa o convite aguardando ativação; a aprovação ativa a parceria automaticamente. O convite exige que a pessoa entre com o e-mail convidado e escolha uma organização em que pode gerir afiliados.

Qualquer lado pode encerrar a parceria. O histórico permanece, e a parceria encerrada não pode ser incluída em pagamentos novos. Para retomar a relação, crie outra parceria, com outro ID.

## Chargefy for Platforms

> [!WARNING]
>
> Esta seção só se aplica a contas com o produto **Chargefy for Platforms** habilitado. Nesse produto, uma plataforma opera pagamentos para **suas organizações filhas**.

A plataforma pode [criar diretamente uma parceria](https://docs.chargefy.io/api-reference/affiliations/create.md) entre duas filhas ativas de sua rede, sem convite. A afiliada precisa ter cadastro financeiro aprovado e um documento fiscal diferente do da dona do programa.

Na Escola Lumen, Ana entra como organização afiliada; a plataforma que opera as duas organizações cria o vínculo e recebe a confirmação. Cada organização acompanha a parceria no próprio contexto. Os eventos [affiliation.created](https://docs.chargefy.io/api-reference/webhooks/affiliation.created.md) e [affiliation.ended](https://docs.chargefy.io/api-reference/webhooks/affiliation.ended.md) informam quando ela passa a valer ou termina.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.