Skip to main content
DELETE
Remover split
DELETE /splits/:id Faz parte do recurso Splits — as regras de validação do array config estão lá. Remove a configuração: ela some das consultas e não pode mais ser referenciada em payments[].splitId. A resposta traz o split com deletedAt preenchido.
É remoção lógica. O registro continua existindo para as vendas passadas — o que já foi dividido por essa regra permanece registrado na transação, com os valores que valeram na hora.
Uma integração que guarde o spl_ passa a falhar. Depois da remoção, criar uma transação com aquele splitId é recusado. Se o identificador está gravado no seu lado, troque-o antes de remover — ou a próxima venda para em erro.
Para desativar sem remover, use isActive: false em PATCH /splits/{id}. É reversível, e é o caminho quando a divisão pode voltar a valer.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do split

Response

Split removido

id
string

Identificador único do registro.

name
string

Nome do registro.

config
object[]

Regras de divisão do split por recebedor.

salesKey
string | null

Chave de vendas (salesKey) associada ao split.

checkoutId
string | null

ID do checkout vinculado à configuração de split.

isActive
boolean

Indica se o registro está ativo.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).

deletedAt
string<date-time> | null

Data e hora de exclusão (soft delete); nulo se ativo.