Consultar um template de regra de split.
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).
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).
Autorização
ApiKeyAuth Em: header
Parâmetros de caminho
^spr_[A-Za-z0-9]+$Corpo da resposta
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/split-rules/spr_xxx"{ "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"}Criar um template de regra de split. POST
Cria um template de split nomeado, reutilizável e versionado para o whitelabel, por valor ou por basis points. Uma cobrança pode depois referenciá-lo pelo id público (split_rule_id) para materializar o split[] no momento da criação da cobrança — reutilizando o mesmo motor de split inline, sem um segundo motor de cálculo. Exige a permissão split_rules:manage e uma key com escopo de whitelabel (sem seller). Todos os recebedores devem usar o mesmo modo de alocação (amount_cents ou percentage_bps); os recebedores são sellers do mesmo whitelabel.
Editar uma regra de split. PATCH
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.