Listar templates de regra de split.
Lista os templates de regra de split do whitelabel. Exige a permissão split_rules:read e uma key com escopo de whitelabel (sem seller).
Lista os templates de regra de split do whitelabel. Exige a permissão split_rules:read e uma key com escopo de whitelabel (sem seller).
Autorização
ApiKeyAuth Em: header
Corpo da resposta
application/json
application/json
application/json
curl -X GET "https://example.com/split-rules"{ "object": "list", "data": [ { "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" } ], "request_id": "req_xxx"}Consultar uma antecipação. GET
Retorna uma antecipação com escopo do tenant pelo id público. Exige a permissão anticipations:read e uma key com escopo de seller.
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.