🔀 Split Pós (Após a Transação)

Além do split no momento da criação da transação, a Paytime também permite o gerenciamento de splits em transações já criadas.

📌 Endpoint

POST urlServidor/v1/marketplace/transactions/id/split

⚠️ Substitua urlServidor pela URL do servidor correspondente ao seu ambiente (sandbox ou produção).

Exemplo de header da requisição

curl--request POST \
--location '/v1/marketplace/transactions/123/split' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros da Requisição

Headers

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token de autenticação. Pode ser encontrado em nosso portal na guia de integração.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Parâmetros de Path

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da transação onde o split será aplicado.

📥 Modelo Payload (Body)

{
  "title": "Comissão EC Secundário",
  "division": "PERCENTAGE",
  "establishments": [
    {
      "id": 9876,
      "value": 30
    }
  ]
}

Parâmetros do Body

Campo	Tipo	Obrigatório	Descrição
`title`	string	Sim	Título informativo para identificar o split. Exemplo: `"Comissão EC Secundário"`
`division`	string	Sim	Regra da divisão. Valores possíveis: `PERCENTAGE` (porcentagem) ou `CURRENCY` (valor fixo).
`establishments`	array	Sim	Lista dos estabelecimentos que participarão do split.
`establishments[].id`	number	Sim	ID do estabelecimento secundário.
`establishments[].value`	number	Sim	Valor do split. Em centavos para a regra de divisão igual à "CURRENCY". Em porcentagem para a regra de divisão igual à "PERCENTAGE"

✅ Exemplo de Resposta (200):

{
  "message": "Processo de Split iniciado"
}

⚙️ Funcionalidades Disponíveis

Com este endpoint, é possível:

Aplicar um split manualmente em uma transação existente.
Desfazer um split previamente aplicado (revertendo a divisão).
Refazer o split, ajustando a distribuição conforme novas regras de negócio.

📝 Observações Importantes

O Split Pós é especialmente útil em cenários onde:
- A regra de divisão só é conhecida após o fechamento da transação.
- Há necessidade de ajustes por motivos operacionais ou comerciais.
A transação original permanece válida mesmo em caso de falha no split.
Recomenda-se acompanhar os resultados por meio dos webhooks de split para verificar sucesso ou falha da operação.

✅ Regras de Aplicação do Split Pós

Consulte a documentação Regras de Split

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.