Vendedores

Os vendedores (sellers) representam os recebedores secundários que podem participar de uma venda com split, recebendo parte do valor da transação conforme as regras de divisão informadas.

Cada vendedor possui um identificador único, utilizado para consultar seus dados, controlar sua situação e vinculá-lo às operações de split de pagamento.

Antes de utilizar um vendedor em uma venda com split, certifique-se de que ele esteja cadastrado e ativo.

Recebedor principal e vendedores

Em uma venda com split, os recebedores são classificados como primary e secondary.

Tipo	Recebedor	Descrição
`primary`	Estabelecimento	É o recebedor principal da venda e corresponde ao estabelecimento responsável pela transação.
`secondary`	Vendedor	Recebedor secundário cadastrado e vinculado ao `split` pelo `seller_uuid`.

O estabelecimento sempre ocupa a posição de primary, enquanto os vendedores participantes do split são considerados secondary.

A divisão dos valores deve respeitar as regras definidas para o estabelecimento, como o valor mínimo que deve permanecer com o ele após o cálculo e a distribuição do split entre os vendedores.

📘
Participação do estabelecimento:
O estabelecimento deve sempre participar do split, mesmo quando a maior parte do pagamento seja destinada aos vendedores.

Operações disponíveis

Operação	Método	Descrição
Criar Vendedor	`POST`	Cadastra um novo vendedor.
Consultar Vendedores	`GET`	Retorna a lista de vendedores cadastrados.
Consultar um Vendedor	`GET`	Retorna os dados de um vendedor específico.
Ativar um Vendedor	`PUT`	Ativa um vendedor previamente cadastrado.
Inativar um Vendedor	`PUT`	Inativa um vendedor, impedindo sua utilização em novas operações.

Cadastro de vendedores

Para participar de vendas com split e receber repasses, o vendedor deve ser cadastrado na Cyclopay. Após o envio dos dados, o cadastro passará por análise.

Quando houver uma atualização no status do vendedor, referente a aprovação ou não, a URL de webhook configurada será notificada.

Status de vendedores

Abaixo estão os possíveis status de um vendedor.

Situação	Status	Descrição
Ativo	active	Vendedor ativo.
Inativo	inactive	Vendedor inativo.
Pendente de aprovação	pending_approval	Vendedor pendente de aprovação na análise. Vendedores com esse status ficam impedidos de receberem valores.
Suspenso	suspended	Vendedor suspenso.
Cancelado	canceled	Vendedor cancelado. Vendedores com esse status impedidos de receberem valores.
Bloqueado	blocked	Vendedor bloqueado.

📘
Somente vendedores com status active podem ser vinculados a novas vendas com split.

Utilização em vendas com split

Para incluir um vendedor na divisão da venda, informe seu identificador no campo seller_uuid e defina sua forma de recebimento por meio do campo type.

📘
Regras para utilização:

somente vendedores aprovados e ativos podem participar do split;

um mesmo seller_uuid não pode ser informado mais de uma vez;

os vendedores (secondary) podem utilizar os tipos AMOUNT, PERCENTAGE ou REMAINING;

quando há sobra no cálculo do split, o valor restante será destinado automaticamente ao estabelecimento (primary);

quando um vendedor utilizar o tipo REMAINING, o recebedor primary também deverá ser informado no split com sua participação definida por AMOUNT ou PERCENTAGE.

Webhooks

Os webhooks permitem receber notificações quando houver uma atualização no status de um vendedor, como a conclusão da análise do cadastro.

Verifique a seção Vendedores > Webhooks para mais detalhes.