🚧
Habilitação do Split e cadastro de Vendedores
Para utilização do do recurso de split e cadastro de vendedores, verificar previamente a liberação diretamente com a Lyra collect, através do e-mail: [email protected]

Split de pagamentos - Conceito geral

O split de pagamento, ou divisão de pagamento, é um recurso que divide automaticamente os valores de uma transação entre os envolvidos. É uma solução indicada para plataformas de venda online onde há um ou mais participantes, como por exemplo marketplaces, franquias e clínicas.

O split funciona da seguinte forma:

O cliente realiza um pagamento único.
O valor é dividido automaticamente entre os vendedores e prestadores de serviços.
Cada valor é direcionado para a conta do respectivo dono.

Os benefícios do split de pagamento incluem:

Redução de erros de repasse.
Melhoria da segurança das transações.
Facilidade na declaração de impostos.
Automatização do processo de conciliação financeira.

Vendedores

Os vendedores são as partes envolvidas no processo que irão receber parte do pagamento no processo da liquidação.

Em nossa plataforma é possível configurar e definir no momento da venda, ou após, um ou mais vendedores, os valores por inteiro, percentual e quem irá receber o restante da divisão.

Cadastro de vendedores

Para que haja o repasse financeiro aos vendedores, será necessário solicitar o cadastro em nossa base de dados.

A solicitação passará por uma análise para então aprovar ou não o cadastro desse vendedor.

Para realizar o cadastro, verifique nossa seção Criar Vendedor

Após a criação e aprovação, será enviado um webhook notificando o status do vendedor.

Status de vendedores

Abaixo uma lista dos possíveis status.

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

Split da Transação

É possível executar o split em situações:

Na cobrança da transação
Após a cobrança, sendo o limite até o mesmo dia (até 23:59).

Split com cobrança

É possível parametrizar as definições do split diretamente na venda, através do objeto split

📘
Meios de Pagamento
O objeto está disponível para utilizar nos meios de pagamentos Cartão, Pix e Boleto

Campo	Nome	Descrição	Exemplo
seller_uuid	Identificação do Vendedor	UUid do seller (vendedor)
type	Tipo de divisão/split	tipo da divisão do pagamento. "AMOUNT", "PERCENTAGE" ou "REMAINING"	o tipo "REMAINING" sinaliza que o vendedor irá receber o restante do valor não alocado.
amount	Valor	valor ou percentual a ser recebido. Ex.: 100% = 10000 ou 35,55% = 3555	R$ 50,00 = 5000, R$ 12.000 = 1200000

Exemplos de código:

{
    "amount": 8000,
    "order_id": "BR0000-{{$randomBankAccount}}",
    "order_info": "charge description",
    "currency": "BRL",
    "type": "PAYMENT",
    "soft_descriptor": "PAYTEST",
    "client_ip": "{{$randomIP}}",
    "payments": [
        {
            "payment_method": "card",
            "amount": 8000,
            "create_token": true,
            "card": {
                "number": "5970100300000067",
                "exp_year": 2025,
                "exp_month": 12,
                "cvv": "1234",
                "holder_name": "{{$randomFullName}}"
            }
        }
    ],
    "customer": {
        "name": "{{$randomFullName}}",
        "email": "{{$randomEmail}}",
        "phone": "551198570711",
        "mobile_phone": "5511985270748",
        "birth_date": "2000-01-01",
        "document_type": "CPF",
        "document_number": "62286843023"
    },
    "split": [
        {
            "seller_uuid": "2f4ae2db-36ea-46fe-b11c-186718eb8b17",
            "type": "PERCENTAGE",
            "amount": 5000
        },
        {
            "seller_uuid": "4e913ae0-aeb2-4083-ba76-86d79c440052",
            "type": "PERCENTAGE",
            "amount": 5000
        }
    ]
}

{
    "amount": 8000,
    "order_id": "BR0000-{{$randomBankAccount}}",
    "order_info": "charge description",
    "currency": "BRL",
    "type": "PAYMENT",
    "soft_descriptor": "PAYTEST",
    "client_ip": "{{$randomIP}}",
    "payments": [
        {
            "payment_method": "pix-cob",
            "amount": 8000,
            "pix": {
                "expires": 1800
            }
        }
    ],
    "customer": {
        "name": "{{$randomFullName}}",
        "email": "{{$randomEmail}}",
        "phone": "551198570711",
        "mobile_phone": "5511985270748",
        "birth_date": "2000-01-01",
        "document_type": "CPF",
        "document_number": "62286843023"
    },
    "split": [
        {
            "seller_uuid": "2f4ae2db-36ea-46fe-b11c-186718eb8b17",
            "type": "PERCENTAGE",
            "amount": 5000
        }
    ]
}

{
    "amount": 8000,
    "order_id": "BR0000-{{$randomBankAccount}}",
    "order_info": "charge description",
    "currency": "BRL",
    "type": "PAYMENT",
    "soft_descriptor": "PAYTEST",
    "client_ip": "{{$randomIP}}",
    "payments": [
            {
            "payment_method": "boleto",
            "amount": 8000,
            "boleto": {
                "due_date": "2024-12-30"
            }
        }
    ],
    "customer": {
        "name": "{{$randomFullName}}",
        "email": "{{$randomEmail}}",
        "phone": "551198570711",
        "mobile_phone": "5511985270748",
        "birth_date": "2000-01-01",
        "document_type": "CPF",
        "document_number": "62286843023"
    },
    "split": [
        {
            "seller_uuid": "2f4ae2db-36ea-46fe-b11c-186718eb8b17",
            "type": "PERCENTAGE",
            "amount": 5000
        },
        {
            "seller_uuid": "4e913ae0-aeb2-4083-ba76-86d79c440052",
            "type": "PERCENTAGE",
            "amount": 5000
        }
    ]
}

Split após cobrança

(Documentação em breve)

Consultar Status de Split em uma Venda

É possível consultar os valores e status das situações do split através do método de consulta, verifique nossa seção Consultar Split de uma Venda

Os campos settlement_status_code e settlement_status_description sinalizam a situação de acordo a tabela abaixo:

settlement_status_code	settlement_status_description	Descrição
1001	PENDING	Pendente de pagamento ou aprovação.
1002	READY_TO_SETTLE	Pagamento aprovado, pronto para liquidação.
1003	SETTLEMENT_SENT	Liquidação pendente.
1004	SETTLED	Liquidado.