Splits e Rateios

Este módulo gerencia a divisão automática de recebíveis entre diferentes contas ou beneficiários externos.

---

Listar Rateios Agrupados

[GET] /splits

Retorna a lista de rateios agrupados por dados bancários e status, facilitando a gestão de pagamentos por beneficiário.

Query Params

Nome	Tipo	Descrição
search	string	Busca por nome, documento, número da conta ou banco.
date_filter	string	Filtros rápidos: week, month ou uma data específica YYYY-MM-DD.

Response (200 OK)

{
  "message": "Rateios agrupados com sucesso.",
  "data": [
    {
      "account_data_holder_name": "BENEFICIARIO EXEMPLO",
      "account_data_holder_document": "12345678901",
      "account_data_account_number": "12345",
      "account_data_branch_number": "0001",
      "account_data_account_type": "CORRENTE",
      "bank_institution_id": 1,
      "status": "pending",
      "total_sum_amount": 1050.75,
      "charges_count": 5,
      "bank_institution": {
        "id": 1,
        "ispb": "00000000",
        "full_name": "Banco do Brasil S.A.",
        "code": "001"
      }
    }
  ]
}

---

Rateios de uma Cobrança

[GET] /splits/invoice/{id_ou_code}

Retorna todas as regras de split configuradas para uma cobrança específica.

Response (200 OK)

{
  "invoice_id": "ch_7a8b9c",
  "rateios": [
    {
      "id": 15,
      "charge_id": 102,
      "account_data_holder_name": "BENEFICIARIO 1",
      "amount": 50.0,
      "percentage_amount": 20.0,
      "status": "pending",
      "bank_institution": { "id": 1, "code": "001" }
    }
  ],
  "Invoice": {
    "id": 102,
    "code": "ch_7a8b9c",
    "value": 250.0,
    "status": { "title": "pending" }
  }
}

---

Consultar Beneficiários (Contas com Rateios)

[GET] /splits/accounts

Retorna uma lista única de todos os dados bancários para os quais já foram criadas regras de rateio.

Response (200 OK)

{
  "current_page": 1,
  "data": [
    {
      "account_data_holder_name": "MARIA SOUZA",
      "account_data_holder_document": "98765432109",
      "account_data_account_number": "99988",
      "account_data_branch_number": "0001",
      "account_data_account_type": "POUPANCA",
      "bank_institution": {
        "id": 10,
        "ispb": "00360305",
        "short_name": "CAIXA",
        "full_name": "CAIXA ECONOMICA FEDERAL",
        "institution_name": "Caixa Econômica Federal"
      }
    }
  ],
  "total": 5
}

---

Ver Detalhes do Rateio

[GET] /splits/{id}

Response (200 OK)

{
  "split": {
    "id": 15,
    "charge_id": 102,
    "account_data_holder_name": "BENEFICIARIO 1",
    "amount": 50.0,
    "status": "pending",
    "charge": { "id": 102, "code": "ch_7a8b9c" },
    "transaction": null
  },
  "message": "Informações do rateio"
}

---

Processar Pagamento de Split

[POST] /splits/{id}/pay

Inicia o processamento do pagamento de um rateio específico para o beneficiário.

Response (200 OK)

{
  "split": {
    "id": 15,
    "status": "processing",
    "message": "Processando pagamento"
  },
  "message": "Informações do rateio"
}

(Nota: O comportamento deste endpoint depende da integração bancária ativa)

Webhooks de Cobrança

Endpoints para gerenciamento de notificações via Webhook.

[POST] /webhooks/send-charge/{chargeId}

Reenvia manualmente os dados de uma cobrança para a URL de webhook configurada.

Response (200 OK)

{
  "success": true,
  "message": "Notificação enviada com sucesso!"
}

---

[POST] /upload

Faz o upload de arquivos binários.

Response (200 OK)

{
  "path": "/storage/uploads/file_abc123.jpg",
  "url": "https://api.fastgivemoney.com/storage/uploads/file_abc123.jpg"
}

(Estrutura de resposta pode variar conforme o arquivo)