Documentação
  1. GESTÃO DE TRANSAÇÕES
  2. Pré-split

Criar regra de split pré

Permite ao estabelecimento configurar previamente uma regra de divisão de valores (split) para suas transações, com base em canal, modalidade e número de parcelas.

🔼

POST urlServidor/v1/marketplace/establishments/{establishment_id}/split-pre

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Exemplo de header da requisição

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

Parâmetros da Requisição

Headers

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken de autenticação. Pode ser encontrado em nosso portal na guia de integração.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth

Parâmetros de Path

NomeTipoObrigatórioDescrição
establishment_idstringSimID do estabelecimento

📤 Exemplo de Payload

{
  "title": "Comissão Sandbox Atualizado",
  "modality": "PIX",
  "channel": "ALL",
  "division": "PERCENTAGE",
  "active": true,
  "installment": 2,
  "establishments": [
    {
      "id": 4155082,
      "active": true,
      "value": 30
    }, {
      "id": 4155099,
      "active": true,
      "value": 30
    },
     {
      "id": 4155100,
      "active": true,
      "value": 20
    }
  ]
}

📤Explicação do Payload

CampoTipoObrigatórioDescrição
titlestringSimTítulo da regra de split para identificação. Exemplo: "Comissão de Vendas Online"
modalitystringSimModalidade que a regra será aplicada. <br>Valores possíveis: ALL, CREDIT, DEBIT, PIX
channelstringSimCanal de venda para aplicar a regra. <br>Valores: ALL, CHIP, TAP, SMART, ONLINE
divisionstringSimTipo de divisão. <br>Valores: PERCENTAGE (porcentagem) ou CURRENCY (valor fixo em centavos)
activebooleanSimIndica se a regra estará ativa após sua criação.
installmentnumberNãoNúmero de parcelas que a regra se aplica. Ex: 1 para vendas à vista, 3 para parcelado.
establishmentsarraySimLista de estabelecimentos participantes da regra.
establishments[].idnumberSimID do estabelecimento secundário participante.
establishments[].activebooleanSimIndica se o split para o estabelecimento está ativo.
establishments[].valuenumberSimValor (em centavos ou %) destinado ao estabelecimento.<br>Comportamento depende do campo division.

✅ Exemplo de Resposta

{
    "id": 3,
    "title": "Comissão Sandbox Atualizado",
    "modality": "PIX",
    "channel": "ALL",
    "division": "PERCENTAGE",
    "installment": 2,
    "active": 1,
    "establishment_percentage": 20,
    "establishment": {
        "id": 415585,
        "first_name": "EC Cobranças",
        "last_name": null,
        "document": "10068114001"
    },
    "establishments": [
        {
            "value": 30,
            "priority": 1,
            "active": 1,
            "establishment": {
                "id": 415582,
                "first_name": "Webhooks Integrações",
                "last_name": "API Integrações",
                "document": "60274849000185"
            }
        },
        {
            "value": 30,
            "priority": 2,
            "active": 1,
            "establishment": {
                "id": 415599,
                "first_name": "Atacadão dos Programadores",
                "last_name": "Atacadão DEV",
                "document": "37603116000125"
            }
        },
        {
            "value": 20,
            "priority": 3,
            "active": 1,
            "establishment": {
                "id": 415510,
                "first_name": "Teste Sandbox",
                "last_name": "Solucoes",
                "document": "11299221000129"
            }
        }
    ],
    "__meta__": {
        "ecs_count": 3
    }
}

📋 Explicação de Atributos da Resposta

CampoTipoObrigatórioDescrição
idnumberSimIdentificador único da regra de split criada.
titlestringSimTítulo da regra conforme enviado na requisição.
modalitystringSimModalidade que a regra se aplica: ALL, CREDIT, DEBIT, PIX.
channelstringSimCanal que a regra se aplica: ALL, CHIP, TAP, SMART, ONLINE.
divisionstringSimRegra de divisão utilizada: PERCENTAGE ou CURRENCY.
installmentnumberNãoNúmero de parcelas associado à regra. Pode ser null.
activebooleanSimIndica se a regra está ativa.
establishment_percentagenumberSimPercentual destinado ao estabelecimento principal (após aplicar os splits secundários).
establishment.idnumberSimID do estabelecimento principal.
establishment.first_namestringSimNome ou razão social do estabelecimento principal.
establishment.last_namestringSimNome fantasia do estabelecimento principal.
establishment.documentstringSimCPF ou CNPJ do estabelecimento principal.
establishments[].valuenumberSimValor fixo ou percentual destinado ao estabelecimento secundário.
establishments[].prioritynumberSimOrdem de prioridade na aplicação do split (quando aplicável).
establishments[].activebooleanSimIndica se o split do estabelecimento está ativo.
establishments[].establishment.idnumberSimID do estabelecimento secundário.
establishments[].establishment.first_namestringSimNome/razão social do estabelecimento secundário.
establishments[].establishment.last_namestringSimNome fantasia do estabelecimento secundário.
establishments[].establishment.documentstringSimDocumento (CPF/CNPJ) do estabelecimento secundário.
__meta__.ecs_countnumberSimQuantidade de estabelecimentos participantes ativos na regra.

⚠️ Observações

O estabelecimento principal recebe automaticamente o saldo restante do split.

É possível criar múltiplas regras, desde que não conflitem entre si (ex: não repetir ALL com CREDIT).

As regras podem ser editadas ou desativadas posteriormente via API.

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.

Updated 6 months ago

Did this page help you?