Skip to main content
PATCH
Atualizar split
PATCH /splits/:id Faz parte do recurso Splits — as regras de validação do array config estão lá. Atualização parcial: envie só o que quer alterar. A resposta é a configuração atualizada.
O config é substituído por inteiro, não mesclado. Enviar o array significa enviar a divisão completa: um item que você não repetir deixa de existir. Para mudar o percentual de um recebedor, mande todos os itens de novo, com o valor novo naquele.
As vendas já feitas não mudam. A configuração é lida no momento da cobrança — o que já foi dividido está registrado na transação e não é reescrito. Alterar aqui vale para as próximas.Isso também significa que não há histórico de versões: ao contrário do preço de um plano, o split é sobrescrito. Se precisar comparar o antes e o depois, guarde do seu lado.
A validação é a mesma da criação. As quatro regras do config e os dois níveis de checagem dos recebedores valem igual — inclusive o que não é checado: o status do vínculo só é conferido na cobrança. Ver Criar split.

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

Body

application/json
name
string
Minimum string length: 1
config
object[]
Minimum array length: 1
salesKey
string | null
checkoutId
string | null
isActive
boolean

Response

Split atualizado

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).