API de Split de Pagamentos

9 endpoints · base https://api.comando.one/v1 · autenticação por chave cmd_live_…

GET/split-executions

Listar execuções de split

split:list

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`status`(query)	"pending" \| "calculated" \| "releasing" \| "completed" \| "partial" \| "reversed" \| "failed"
`invoice_id`(query)	string (uuid)
`supplier_id`(query)	string (uuid)	Filtra execuções que contenham fatia deste fornecedor

Resposta 200 — Listagem paginada

`id`	string (uuid)
`invoice_id`	string \| null (uuid)
`charge_id`	string \| null (uuid)
`split_rule_id`	string \| null (uuid)
`gateway_provider`	string \| null
`gross_cents`	integer
`gateway_fee_cents`	integer
`net_cents`	integer
`fiscal_mode`	"intermediacao" \| "revenda"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`status`	"pending" \| "calculated" \| "releasing" \| "completed" \| "partial" \| "reversed" \| "failed"
`settled_at`	string \| null (date-time)
`error_message`	string \| null
`items`	array de SplitExecutionItem
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/split-executions" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/split-executions/{id}

Obter execução de split (com fatias)

split:list

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Execução

`id`	string (uuid)
`invoice_id`	string \| null (uuid)
`charge_id`	string \| null (uuid)
`split_rule_id`	string \| null (uuid)
`gateway_provider`	string \| null
`gross_cents`	integer
`gateway_fee_cents`	integer
`net_cents`	integer
`fiscal_mode`	"intermediacao" \| "revenda"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`status`	"pending" \| "calculated" \| "releasing" \| "completed" \| "partial" \| "reversed" \| "failed"
`settled_at`	string \| null (date-time)
`error_message`	string \| null
`items`	array de SplitExecutionItem
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/split-executions/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/split-executions/{id}/reverse

Estornar execução de split

Marca a execução e suas fatias como 'reversed'. Para cada fatia de fornecedor já paga, registra um ajuste de recuperação (o fornecedor deve devolver o valor). 2FA: se a empresa exige verificação em duas etapas para movimentar dinheiro (Configurações → Segurança), uma chave de API sem usuário recebe 403; pelo chat ou por OAuth é preciso enviar o cabeçalho X-Payment-Step-Up-Grant, emitido pela verificação 2FA no app.

split:update

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Estornada

`execution_id`	string
`status`	string
`adjustments_created`	integer
`recover_amount_cents`	integer

Exemplo

curl -X POST "https://api.comando.one/v1/split-executions/{id}/reverse" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/split-items/{id}/release

Liberar fatia manualmente

Libera uma fatia (pending/awaiting_nota/failed → released), apta a virar payout. 2FA: se a empresa exige verificação em duas etapas para movimentar dinheiro (Configurações → Segurança), uma chave de API sem usuário recebe 403; pelo chat ou por OAuth é preciso enviar o cabeçalho X-Payment-Step-Up-Grant, emitido pela verificação 2FA no app.

split:update

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Liberada

`id`	string
`status`	string

Exemplo

curl -X POST "https://api.comando.one/v1/split-items/{id}/release" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/split-rules

Listar regras de split

split:list

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`scope`(query)	"company_default" \| "contract" \| "invoice" \| "charge"

Resposta 200 — Listagem paginada

`id`	string (uuid)
`name`	string
`description`	string \| null
`scope`	"company_default" \| "contract" \| "invoice" \| "charge"
`contract_id`	string \| null (uuid)
`fiscal_mode`	"intermediacao" \| "revenda"
`fee_payer`	"platform" \| "recipients" \| "proportional"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`rounding_strategy`	"remainder_to_master" \| "largest_remainder"
`is_active`	boolean
`gateway_split_enabled`	boolean	Quando true, usa o split nativo da Pagar.me (divisão no ato do pagamento) se a cobrança for Pagar.me e os fornecedores tiverem recebedor aprovado; senão, repasse interno.
`recipients`	array de SplitRuleRecipient
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/split-rules" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/split-rules

Criar regra de split

Cria uma regra de divisão com seus beneficiários (recipients). Percentual primeiro, depois fixo; soma de percentuais ≤ 100.

split:create

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`name`obrigatório	string
`description`	string
`scope`	"company_default" \| "contract" \| "invoice" \| "charge"
`contract_id`	string (uuid)	Obrigatório quando scope=contract
`fiscal_mode`	"intermediacao" \| "revenda"
`fee_payer`	"platform" \| "recipients" \| "proportional"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`rounding_strategy`	"remainder_to_master" \| "largest_remainder"
`is_active`	boolean
`gateway_split_enabled`	boolean	Usar o split nativo da Pagar.me quando aplicável (senão repasse interno).
`recipients`obrigatório	array de object	Beneficiários. Percentual primeiro, depois fixo. Soma de percentuais ≤ 100.

Resposta 201 — Regra criada

`id`	string (uuid)
`name`	string
`description`	string \| null
`scope`	"company_default" \| "contract" \| "invoice" \| "charge"
`contract_id`	string \| null (uuid)
`fiscal_mode`	"intermediacao" \| "revenda"
`fee_payer`	"platform" \| "recipients" \| "proportional"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`rounding_strategy`	"remainder_to_master" \| "largest_remainder"
`is_active`	boolean
`gateway_split_enabled`	boolean	Quando true, usa o split nativo da Pagar.me (divisão no ato do pagamento) se a cobrança for Pagar.me e os fornecedores tiverem recebedor aprovado; senão, repasse interno.
`recipients`	array de SplitRuleRecipient
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/split-rules" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"name":"<string>","recipients":"<array de object>"}'

DELETE/split-rules/{id}

Excluir regra de split

split:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Removida

`deleted`	boolean
`id`	string

Exemplo

curl -X DELETE "https://api.comando.one/v1/split-rules/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/split-rules/{id}

Obter regra de split

split:list

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Regra

`id`	string (uuid)
`name`	string
`description`	string \| null
`scope`	"company_default" \| "contract" \| "invoice" \| "charge"
`contract_id`	string \| null (uuid)
`fiscal_mode`	"intermediacao" \| "revenda"
`fee_payer`	"platform" \| "recipients" \| "proportional"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`rounding_strategy`	"remainder_to_master" \| "largest_remainder"
`is_active`	boolean
`gateway_split_enabled`	boolean	Quando true, usa o split nativo da Pagar.me (divisão no ato do pagamento) se a cobrança for Pagar.me e os fornecedores tiverem recebedor aprovado; senão, repasse interno.
`recipients`	array de SplitRuleRecipient
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/split-rules/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

PATCH/split-rules/{id}

Atualizar regra de split

Atualiza campos da regra. Se 'recipients' for enviado, substitui todos os beneficiários.

split:update

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`name`obrigatório	string
`description`	string
`scope`	"company_default" \| "contract" \| "invoice" \| "charge"
`contract_id`	string (uuid)	Obrigatório quando scope=contract
`fiscal_mode`	"intermediacao" \| "revenda"
`fee_payer`	"platform" \| "recipients" \| "proportional"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`rounding_strategy`	"remainder_to_master" \| "largest_remainder"
`is_active`	boolean
`gateway_split_enabled`	boolean	Usar o split nativo da Pagar.me quando aplicável (senão repasse interno).
`recipients`obrigatório	array de object	Beneficiários. Percentual primeiro, depois fixo. Soma de percentuais ≤ 100.

Resposta 200 — Regra atualizada

`id`	string (uuid)
`name`	string
`description`	string \| null
`scope`	"company_default" \| "contract" \| "invoice" \| "charge"
`contract_id`	string \| null (uuid)
`fiscal_mode`	"intermediacao" \| "revenda"
`fee_payer`	"platform" \| "recipients" \| "proportional"
`release_trigger`	"on_settlement" \| "on_nota" \| "manual" \| "scheduled"
`rounding_strategy`	"remainder_to_master" \| "largest_remainder"
`is_active`	boolean
`gateway_split_enabled`	boolean	Quando true, usa o split nativo da Pagar.me (divisão no ato do pagamento) se a cobrança for Pagar.me e os fornecedores tiverem recebedor aprovado; senão, repasse interno.
`recipients`	array de SplitRuleRecipient
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/split-rules/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"name":"<string>","recipients":"<array de object>"}'

Início rápido, autenticação, SDK, servidor MCP e o playground para testar sem escrever código estão na documentação completa. A especificação em OpenAPI está em api.comando.one/openapi.json.

Outros recursos da API

Clientes (16)Contratos (13)Faturas (12)Webhooks (12)Serviços (9)Catálogos (7)Propostas (6)NFS-e (6)

Ou deixe a IA usar a API por você

O servidor MCP expõe estes mesmos recursos ao ChatGPT, Claude ou Gemini — com OAuth, sem chave de API.

Conectar um assistente