> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Atualizar split
> Altera uma configuração de divisão. Não mexe nas vendas que já usaram a versão anterior.
`PATCH /splits/:id`
Faz parte do recurso [Splits](/pt-BR/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](/pt-BR/splits/create).
## Exemplo
```bash theme={null}
curl -X PATCH https://api.sandbox.z2pay.com/v1/splits/spl_t8k3nzc1qvre6y0wjaxm5fdbh \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
-H "Content-Type: application/json" \
-d '{
"name": "Marketplace — 70/30",
"config": [
{
"recipientId": "rec_v57bi6ruyolouw3cpaq2ofy1k",
"value": 70,
"valueType": "percentage",
"type": "sale",
"processingFee": true,
"liable": true
},
{
"recipientId": "rec_h2q8dm4xzkw05rbvtsc7jyneo",
"value": 30,
"valueType": "percentage",
"type": "platform_fee",
"processingFee": false,
"liable": false
}
]
}'
```
```json Resposta 200 theme={null}
{
"id": "spl_t8k3nzc1qvre6y0wjaxm5fdbh",
"name": "Marketplace — 70/30",
"isActive": true,
"config": [
{
"recipientId": "rec_v57bi6ruyolouw3cpaq2ofy1k",
"value": 70,
"valueType": "percentage",
"type": "sale",
"processingFee": true,
"liable": true
},
{
"recipientId": "rec_h2q8dm4xzkw05rbvtsc7jyneo",
"value": 30,
"valueType": "percentage",
"type": "platform_fee",
"processingFee": false,
"liable": false
}
],
"updatedAt": "2026-08-11T12:20:00.000Z"
}
```
## OpenAPI
````yaml openapi/psp.json PATCH /splits/{id}
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/splits/{id}:
patch:
tags:
- Splits
summary: Atualizar split
description: Atualiza um split existente
operationId: SplitConfigController_update
parameters:
- name: id
in: path
required: true
description: ID do split
schema:
type: string
- name: Idempotency-Key
in: header
required: false
description: Chave única para garantir idempotência da requisição
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
config:
type: array
items:
type: object
properties:
recipientId:
type: string
minLength: 1
type:
type: string
enum:
- sale
- interest
- platform_fee
default: sale
value:
type: number
minimum: 0.01
valueType:
type: string
enum:
- percentage
- fixed
processingFee:
type: boolean
liable:
type: boolean
required:
- recipientId
- value
- valueType
minItems: 1
salesKey:
type: string
nullable: true
checkoutId:
type: string
nullable: true
isActive:
type: boolean
responses:
'200':
description: Split atualizado
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
name:
type: string
description: Nome do registro.
config:
type: array
items:
type: object
properties:
recipientId:
type: string
description: ID do recebedor.
type:
type: string
enum:
- sale
- interest
- platform_fee
description: >-
Categoria da parte do split: sale (venda), interest
(juros) ou platform_fee (taxa da plataforma).
value:
type: number
description: >-
Valor da parte do split (percentual ou em centavos,
conforme valueType).
valueType:
type: string
description: 'Tipo do valor do split: percentage ou fixed.'
processingFee:
type: boolean
description: >-
Indica se esta parte arca com as taxas de
processamento.
liable:
type: boolean
description: >-
Indica se este recebedor é responsável por
chargebacks e estornos desta parte.
description: Regras de divisão do split por recebedor.
salesKey:
type: string
nullable: true
description: Chave de vendas (salesKey) associada ao split.
checkoutId:
type: string
nullable: true
description: ID do checkout vinculado à configuração de split.
isActive:
type: boolean
description: Indica se o registro está ativo.
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: Data e hora da última atualização do registro (ISO 8601).
example:
id: spl_rja7dpb3xfyccdg7ukuicd0am
name: Split padrão produtores
config:
- recipientId: rec_tazseadvfg6aym95njwzvc6fs
type: sale
value: 80
valueType: percentage
processingFee: true
liable: true
- recipientId: rec_guuh4ppadxc0n47i82fuseq5u
type: platform_fee
value: 20
valueType: percentage
processingFee: false
liable: false
salesKey: SALES-2025-ABC
checkoutId: chk_yi65vojl1sh936l7b93tdg8ix
isActive: true
createdAt: '2025-06-29T13:45:30.000Z'
updatedAt: '2025-06-29T13:45:30.000Z'
'400':
description: >-
Requisição inválida — algum parâmetro ou campo do corpo não passou
na validação
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
issues:
type: array
description: >-
Um item por campo rejeitado. Nunca vem vazio: se há
400 de validação, há pelo menos um.
items:
type: object
properties:
path:
type: string
description: >-
Campo que falhou. Vem vazio quando o erro é do
corpo como um todo.
message:
type: string
description: O que há de errado com esse campo.
example:
error:
code: VALIDATION_ERROR
message: Validation failed
issues:
- path: status
message: >-
Status inválido. Valores aceitos: pending,
waiting_payment, paid, refused, canceled, refunded
- path: startDate
message: >-
Data deve ser ISO 8601 com timezone (ex.:
2026-06-24T00:00:00Z)
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'404':
description: Split não encontrado
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: NOT_FOUND
message: Split not found
'409':
description: >-
Já existe uma requisição em andamento com esta Idempotency-Key. A
API aguarda a primeira concluir por até 5 segundos antes de
responder assim
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem do conflito de idempotência. Aqui `error` é
texto, não objeto — ramifique pelo status HTTP.
example:
error: A request with this idempotency key is already being processed
'422':
description: >-
Idempotency-Key já usada com um corpo diferente. Use uma chave nova
para uma operação diferente
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem do conflito de idempotência. Aqui `error` é
texto, não objeto — ramifique pelo status HTTP.
example:
error: Idempotency key already used with a different request body
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````