Editar uma regra de split.
Edita a regra mantendo o MESMO id público e subindo a versão, para que toda integração que manda `split_rule_id` na cobrança continue funcionando — arquivar e recriar trocaria o `spr_` e quebraria todas elas. Regra arquivada não pode ser editada. Chave de lojista só edita a regra dele (a de outro responde 404, nunca 403); chave de white label edita qualquer regra do tenant. Exige a permissão split_rules:manage.
Edita a regra mantendo o MESMO id público e subindo a versão, para que toda integração que manda split_rule_id na cobrança continue funcionando — arquivar e recriar trocaria o spr_ e quebraria todas elas. Regra arquivada não pode ser editada. Chave de lojista só edita a regra dele (a de outro responde 404, nunca 403); chave de white label edita qualquer regra do tenant. Exige a permissão split_rules:manage.
Autorização
ApiKeyAuth Em: header
Parâmetros de caminho
^spr_[A-Za-z0-9]+$Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body em TypeScript.
Edits a split rule in place: same public id, version + 1. owner_seller_id is deliberately absent — moving a rule to another seller would make that seller's charges start commissioning on their own. An omitted condition keeps its current value; an explicit null clears it (no validity window, no cap). recipients is required because the edit replaces the whole list.
Corpo da resposta
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/split-rules/spr_xxx" \ -H "Content-Type: application/json" \ -d '{ "name": "Comissao da agencia", "recipients": [ { "recipient_seller_id": "seller_yyy", "percentage_bps": 2000 } ], "paid_tpv_cap_cents": null }'{ "object": "split_rule", "id": "string", "name": "string", "version": 1, "active": true, "payment_methods": [ "CREDIT_CARD" ], "effective_from": "2019-08-24T14:15:22Z", "effective_to": "2019-08-24T14:15:22Z", "priority": 0, "paid_tpv_cap_cents": 0, "paid_tpv_cents": 0, "paid_tpv_cap_scope": "TOTAL", "monthly_cycle_count": 0, "catchup_boost_enabled": true, "catchup_trigger_day": 0, "catchup_target_bps": 0, "catchup_boost_bps": 0, "recipients": [ { "recipient_seller_id": "string", "amount_cents": 1, "percentage_bps": 1, "liable": true, "payment_methods": [ "CREDIT_CARD" ] } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "request_id": "req_xxx"}Consultar um template de regra de split. GET
Retorna um template de regra de split com escopo de whitelabel pelo id público. Exige a permissão split_rules:read e uma key com escopo de whitelabel (sem seller).
Arquivar um template de regra de split. DELETE
Arquiva (substitui) um template de regra de split. Os templates são snapshots imutáveis, então arquivar apenas altera active=false; a regra não pode mais ser referenciada por novas cobranças, enquanto as cobranças que já a materializaram mantêm seu split congelado. Exige a permissão split_rules:manage e uma key com escopo de whitelabel (sem seller).