📌 Visão Geral

A Paytime permite que, durante a criação de uma transação via rota:

POST {{urlServidor}}/v1/marketplace/transactions

seja informado um objeto split.

Exemplo de header da requisição

curl--request POST \
--location '/v1/marketplace/transactions' \
--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 do Split a ser encaminhado

Campo	Tipo	Obrigatório	Descrição
`title`	string	Sim	Título informativo para identificar o split.
`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):

📥 Modelo Payload (Body)

{
    "payment_type": "PIX",
    "amount": 1005,
    "interest": "CLIENT",
    "client": {
					"first_name":"João",
          "last_name": "da Silva",
          "document": "10068114001",
          "phone":"31992831124",
          "email": "[email protected]"
			 },
       "info_additional": [
           {
                "key": "origin_system",
                "value": "ERP12345"
            },
            {
                "key": "Run",
                "value": "BlackFriday2025"
            }
        ],
        "split": {
        	"title": "Split PIX",
        	"division": "CURRENCY",
       		 "establishments": [
              {
                  "id": 1,
                  "value": 80
              }
            ]
        }
}

Importante: o envio do objeto split não impede a criação da transação primária.

O split é processado em segundo plano, de forma independente da criação da transação.

⚙️ Etapas do Processo

1.📥 Captura da Transação (Primária)

Ocorre a criação da transação no marketplace.
Essa etapa é independente da lógica de split.
Caso a transação seja aprovada, o fluxo segue normalmente para liquidação.

🔀 Execução do Split (em segundo plano)

Após a captura, o sistema inicia a etapa de execução do split.
Nesse momento é verificada a permissão do estabelecimento para realizar operações de split.
Caso o estabelecimento não possua permissão, o split falhará, mas a transação primária continua válida.
O split pode, portanto, resultar em:
- ✅ Sucesso: valores divididos conforme configuração enviada.
- ❌ Falha: transação primária não é afetada.

📝 Observações Técnicas

O objeto split deve ser enviado no payload da transação no momento da criação.
A verificação de permissão do estabelecimento para realizar splits ocorre somente no momento da execução do split, em segundo plano.
Mesmo que o split falhe, a transação original continua válida.
Recomenda-se implementar o consumo dos webhooks para acompanhar atualização da transação