Remover split
curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/splits/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/splits/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/splits/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "spl_rja7dpb3xfyccdg7ukuicd0am",
"name": "Split padrão produtores",
"config": [
{
"recipientId": "rec_tazseadvfg6aym95njwzvc6fs",
"type": "sale",
"value": 80,
"valueType": "percentage",
"processingFee": true,
"liable": true
}
],
"salesKey": "SALES-2025-ABC",
"checkoutId": "chk_yi65vojl1sh936l7b93tdg8ix",
"isActive": false,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T15:00:00.000Z",
"deletedAt": "2025-06-29T15:00:00.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Split not found"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}Splits
Remover split
Tira a configuração de circulação. As vendas que já a usaram continuam como estão.
DELETE
/
splits
/
{id}
Remover split
curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/splits/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/splits/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/splits/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "spl_rja7dpb3xfyccdg7ukuicd0am",
"name": "Split padrão produtores",
"config": [
{
"recipientId": "rec_tazseadvfg6aym95njwzvc6fs",
"type": "sale",
"value": 80,
"valueType": "percentage",
"processingFee": true,
"liable": true
}
],
"salesKey": "SALES-2025-ABC",
"checkoutId": "chk_yi65vojl1sh936l7b93tdg8ix",
"isActive": false,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T15:00:00.000Z",
"deletedAt": "2025-06-29T15:00:00.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Split not found"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}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
curl -X DELETE https://api.sandbox.z2pay.com/v1/splits/spl_t8k3nzc1qvre6y0wjaxm5fdbh \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
Resposta 200
{
"id": "spl_t8k3nzc1qvre6y0wjaxm5fdbh",
"name": "Marketplace — 70/30",
"isActive": true,
"deletedAt": "2026-08-11T12:35:00.000Z"
}
Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID do split
Response
Split removido
Identificador único do registro.
Nome do registro.
Regras de divisão do split por recebedor.
Show child attributes
Show child attributes
Chave de vendas (salesKey) associada ao split.
ID do checkout vinculado à configuração de split.
Indica se o registro está ativo.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
Data e hora de exclusão (soft delete); nulo se ativo.