API de Pagamentos a Fornecedor

Payouts — pagar/agendar Pix e boleto a fornecedores

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

GET/payouts

Listar pagamentos a fornecedor

payouts:read

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" \| "processing" \| "completed" \| "failed" \| "cancelled"
`provider`(query)	"inter" \| "c6bank"
`method`(query)	"pix" \| "boleto"
`bank_account_id`(query)	string (uuid)
`scheduled_from`(query)	string (date)
`scheduled_to`(query)	string (date)

Resposta 200 — Listagem paginada

`id`	string (uuid)
`status`	"pending" \| "processing" \| "completed" \| "failed" \| "cancelled"
`provider`	"inter" \| "c6bank"
`method`	"pix" \| "boleto"
`amount`	number
`scheduled_for`	string \| null (date)
`bank_account_id`	string (uuid)
`purchase_invoice_charge_id`	string \| null (uuid)
`supplier_payment_method_id`	string \| null (uuid)
`provider_reference`	string \| null	codigoSolicitacao (Inter) ou group_id (C6)
`error_message`	string \| null
`executed_at`	string \| null (date-time)
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/payouts

Pagar ou agendar pagamento (Pix/boleto)

Executa ou agenda um pagamento a fornecedor no provider ativo (Inter/C6). Informe o alvo via purchase_invoice_charge_id, supplier_payment_method_id, pix_key/pix_copia_e_cola ou boleto_barcode. 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.

payouts:create

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`bank_account_id`obrigatório	string (uuid)	Conta bancária de origem
`method`obrigatório	"pix" \| "boleto"
`provider`	"inter" \| "c6bank"	Opcional — detectado se houver uma única integração ativa
`amount`	number	Obrigatório se não vier de purchase_invoice_charge_id
`purchase_invoice_charge_id`	string (uuid)	Parcela a quitar (settlement automático)
`supplier_payment_method_id`	string (uuid)	Forma de pagamento do fornecedor (Pix)
`pix_key`	string
`pix_key_type`	"cpf" \| "cnpj" \| "email" \| "phone" \| "random"
`pix_copia_e_cola`	string	QR Pix copia e cola (EMV)
`boleto_barcode`	string
`scheduled_for`	string (date)	Data de agendamento (YYYY-MM-DD); omitir paga à vista

Resposta 201 — Pagamento criado/executado

`id`	string (uuid)
`status`	"pending" \| "processing" \| "completed" \| "failed" \| "cancelled"
`provider`	"inter" \| "c6bank"
`method`	"pix" \| "boleto"
`amount`	number
`scheduled_for`	string \| null (date)
`bank_account_id`	string (uuid)
`purchase_invoice_charge_id`	string \| null (uuid)
`supplier_payment_method_id`	string \| null (uuid)
`provider_reference`	string \| null	codigoSolicitacao (Inter) ou group_id (C6)
`error_message`	string \| null
`executed_at`	string \| null (date-time)
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/payouts" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"bank_account_id":"<string (uuid)>","method":"<\"pix\" | \"boleto\">"}'

GET/payouts/{id}

Obter pagamento

payouts:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Pagamento

`id`	string (uuid)
`status`	"pending" \| "processing" \| "completed" \| "failed" \| "cancelled"
`provider`	"inter" \| "c6bank"
`method`	"pix" \| "boleto"
`amount`	number
`scheduled_for`	string \| null (date)
`bank_account_id`	string (uuid)
`purchase_invoice_charge_id`	string \| null (uuid)
`supplier_payment_method_id`	string \| null (uuid)
`provider_reference`	string \| null	codigoSolicitacao (Inter) ou group_id (C6)
`error_message`	string \| null
`executed_at`	string \| null (date-time)
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/payouts/{id}/cancel

Cancelar pagamento agendado

Cancela um pagamento agendado. Pix agendado no Inter não é cancelável pela API (retorna 422 — cancele no Internet Banking). 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.

payouts:cancel

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Cancelado

`id`	string (uuid)
`status`	"pending" \| "processing" \| "completed" \| "failed" \| "cancelled"
`provider`	"inter" \| "c6bank"
`method`	"pix" \| "boleto"
`amount`	number
`scheduled_for`	string \| null (date)
`bank_account_id`	string (uuid)
`purchase_invoice_charge_id`	string \| null (uuid)
`supplier_payment_method_id`	string \| null (uuid)
`provider_reference`	string \| null	codigoSolicitacao (Inter) ou group_id (C6)
`error_message`	string \| null
`executed_at`	string \| null (date-time)
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/payouts/{id}/sync

Sincronizar status com o banco

payouts:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Status sincronizado

`id`	string (uuid)
`status`	"pending" \| "processing" \| "completed" \| "failed" \| "cancelled"
`provider`	"inter" \| "c6bank"
`method`	"pix" \| "boleto"
`amount`	number
`scheduled_for`	string \| null (date)
`bank_account_id`	string (uuid)
`purchase_invoice_charge_id`	string \| null (uuid)
`supplier_payment_method_id`	string \| null (uuid)
`provider_reference`	string \| null	codigoSolicitacao (Inter) ou group_id (C6)
`error_message`	string \| null
`executed_at`	string \| null (date-time)
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

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)Split de Pagamentos (9)Catálogos (7)Propostas (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