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

Atualizar regra de split pré

Permite atualizar os dados de uma regra de Split Pré-cadastrada por um estabelecimento. Essa funcionalidade é usada para alterar o título, status, participantes, critérios de divisão (por canal, modalidade, etc.) e valores da regra.

🔼

PUT urlServidor/v1/marketplace/establishments/{establishment_id}/split-pre/{split_id}

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/1' \
--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 que está atualizando a regra.
split_idstringSimID da regra de split a ser atualizada.

📤 Exemplo de Requisição

{
  "title": "Comissão SAndbox",
  "modality": "CREDIT",
  "channel": "ONLINE",
  "division": "PERCENTAGE",
  "active": true,
  "installment": 3,
  "establishments": [
    {
      "id": 4155085,
      "active": true,
      "value": 30
    }
  ]
}

📤 Explicação do Corpo da Requisição (Payload)

CampoTipoObrigatórioDescrição
titlestringNãoTítulo descritivo da regra de split.
modalitystringNãoModalidade de transação. <br>ALL, CREDIT, DEBIT, PIX
channelstringNãoCanal de venda. <br>ALL, CHIP, TAP, SMART, ONLINE
divisionstringNãoTipo de divisão. <br>PERCENTAGE (porcentagem) ou CURRENCY (valor fixo)
activebooleanNãoAtiva ou desativa a regra de split.
installmentnumberNãoNúmero de parcelas a que a regra se aplica.
establishmentsarraySimLista de participantes do split.
establishments[].idnumberSimID do estabelecimento participante.
establishments[].activebooleanSimSe o participante está ativo.
establishments[].valuenumberSimValor/percentual atribuído ao participante, conforme o tipo de divisão.

Exemplo de resposta

{
    "id": 2,
    "title": "Comissão SAndbox",
    "modality": "CREDIT",
    "channel": "ONLINE",
    "division": "PERCENTAGE",
    "installment": 3,
    "active": 1,
    "establishment_percentage": 70,
    "establishment": {
        "id": 4155085,
        "first_name": "EC Cobranças",
        "last_name": null,
        "document": "10068114001"
    },
    "establishments": [
        {
            "value": 30,
            "priority": 1,
            "active": 1,
            "establishment": {
                "id": 4155085,
                "first_name": "EC Cobranças",
                "last_name": null,
                "document": "10068114001"
            }
        }
    ],
    "__meta__": {
        "ecs_count": 1
    }
}

📋 Explicação de Atributos da Resposta

CampoTipoDescrição
idnumberID da regra atualizada.
titlestringTítulo da regra.
modalitystringModalidade associada à regra. ALL, CREDIT, DEBIT, PIX
channelstringCanal de venda da regra. ALL, CHIP, TAP, SMART, ONLINE
divisionstringTipo de divisão utilizada: PERCENTAGE ou CURRENCY.
installmentnumberParcelamento associado.
activebooleanStatus atual da regra.
establishment_percentagenumberPercentual restante destinado ao estabelecimento principal.
establishmentobjectDados do EC principal (criador da regra).
└─ id, first_name, last_name, documentvariadosDados cadastrais do EC principal.
establishmentsarrayLista dos estabelecimentos participantes secundários.
establishments[].valuenumberValor atribuído ao estabelecimento.
establishments[].prioritynumberOrdem de prioridade.
establishments[].activebooleanStatus individual da participação no split.
establishments[].establishmentobjectDados do estabelecimento secundário.
└─ id, first_name, last_name, documentvariadosDados cadastrais do EC participante.
__meta__.ecs_countnumberQuantidade total de estabelecimentos participantes ativos.

⚠️ Observações

Regras que abrangem todos os canais e modalidades (ALL) não podem coexistir com regras específicas já ativas.

A divisão deve somar, no máximo, 100% no caso de PERCENTAGE.

Para CURRENCY, o valor dos splits não pode exceder o valor total da transação.

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?