API de Cobranças

Gateway de pagamentos — Pix, boleto e checkout

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

GET/charges

Listar cobranças

charges: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" \| "paid" \| "cancelled" \| "expired" \| "failed"
`method`(query)	"pix" \| "boleto" \| "checkout" \| "credit_card"
`customer_id`(query)	string (uuid)
`invoice_id`(query)	string (uuid)
`sort_by`(query)	"amount" \| "due_date" \| "created_at" \| "paid_at"	Coluna de ordenação. Use com sort_order para responder 'as maiores' ou 'as mais recentes'.
`sort_order`(query)	"asc" \| "desc"	Direção da ordenação. Padrão: desc quando sort_by é informado.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`status`	"pending" \| "paid" \| "cancelled" \| "expired" \| "failed"
`status_raw`	string	Status bruto do provider
`method`	"pix" \| "boleto" \| "checkout" \| "credit_card"
`provider`	"inter" \| "c6bank" \| "pix_offline" \| "pagarme" \| "cora"	Provedor resolvido. 'pix_offline' = Pix estático (BR Code local). 'pagarme' = Pix server-side ou cartão (method=credit_card retorna 'checkout.url' = link da página de pagamento). 'cora' = boleto ou Pix emitidos de forma síncrona (o boleto já volta com 'pdf_url').
`invoice_id`	string \| null (uuid)
`customer_id`	string \| null (uuid)
`amount`	number \| null
`due_date`	string \| null (date)
`pix`	object \| null
`boleto`	object \| null
`checkout`	object \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/charges

Criar cobrança (Pix, boleto, checkout ou cartão)

Gera uma cobrança no provider ativo da empresa (Inter, C6 Bank, Pix Offline, Cora ou Pagar.me). Forneça invoice_id ou customer_id+amount+due_date. Com Pagar.me, method=pix retorna o copia-e-cola e method=credit_card retorna 'checkout.url' (link da página de pagamento própria). Numa fatura PARCELADA, informe `charge_id`: sem ele a cobrança sai no valor cheio da fatura e não fica amarrada a nenhuma parcela — então a baixa não fecha a parcela certa. Use GET /v1/invoices/{id}/charges para descobrir o charge_id.

charges:create

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`method`obrigatório	"pix" \| "boleto" \| "checkout" \| "credit_card"	Canal de pagamento
`provider`	"inter" \| "c6bank" \| "pix_offline" \| "pagarme" \| "cora"	Opcional. Desambigua quando a empresa tem mais de um provedor no mesmo canal (ex.: Pix Inter x Pix Pagar.me x Pix Cora). Se omitido, usa o provedor ativo do canal.
`invoice_id`	string (uuid)	Fatura existente (opcional)
`charge_id`	string (uuid)	PARCELA da fatura a cobrar (invoice_charges.id — veja GET /v1/invoices/{id}/charges). Só vale com invoice_id. Quando informado, a cobrança sai com o VALOR e o VENCIMENTO da parcela e fica amarrada a ela, que é o que dá baixa certa quando o dinheiro entra. Omitido, a cobrança é no nível da fatura (valor cheio) — numa fatura parcelada isso normalmente não é o que se quer.
`customer_id`	string (uuid)	Obrigatório se invoice_id omitido
`amount`	number	Obrigatório se invoice_id omitido
`due_date`	string (date)	Obrigatório se invoice_id omitido
`description`	string

Resposta 201 — Cobrança criada

`id`	string (uuid)
`status`	"pending" \| "paid" \| "cancelled" \| "expired" \| "failed"
`status_raw`	string	Status bruto do provider
`method`	"pix" \| "boleto" \| "checkout" \| "credit_card"
`provider`	"inter" \| "c6bank" \| "pix_offline" \| "pagarme" \| "cora"	Provedor resolvido. 'pix_offline' = Pix estático (BR Code local). 'pagarme' = Pix server-side ou cartão (method=credit_card retorna 'checkout.url' = link da página de pagamento). 'cora' = boleto ou Pix emitidos de forma síncrona (o boleto já volta com 'pdf_url').
`invoice_id`	string \| null (uuid)
`customer_id`	string \| null (uuid)
`amount`	number \| null
`due_date`	string \| null (date)
`pix`	object \| null
`boleto`	object \| null
`checkout`	object \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/charges" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"method":"<\"pix\" | \"boleto\" | \"checkout\" | \"credit_card\">"}'

DELETE/charges/{id}

Cancelar cobrança

charges:cancel

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Cancelamento solicitado

Sem corpo.

Exemplo

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

GET/charges/{id}

Obter cobrança

charges:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Cobrança

`id`	string (uuid)
`status`	"pending" \| "paid" \| "cancelled" \| "expired" \| "failed"
`status_raw`	string	Status bruto do provider
`method`	"pix" \| "boleto" \| "checkout" \| "credit_card"
`provider`	"inter" \| "c6bank" \| "pix_offline" \| "pagarme" \| "cora"	Provedor resolvido. 'pix_offline' = Pix estático (BR Code local). 'pagarme' = Pix server-side ou cartão (method=credit_card retorna 'checkout.url' = link da página de pagamento). 'cora' = boleto ou Pix emitidos de forma síncrona (o boleto já volta com 'pdf_url').
`invoice_id`	string \| null (uuid)
`customer_id`	string \| null (uuid)
`amount`	number \| null
`due_date`	string \| null (date)
`pix`	object \| null
`boleto`	object \| null
`checkout`	object \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/charges/{id}/confirm

Confirmar pagamento (Pix estático/offline)

Marca manualmente uma cobrança Pix estático (provider 'pix_offline') como paga e dispara o webhook charge.paid. Para Inter/C6 a baixa vem do banco (não use este endpoint). É uma baixa: exige o mesmo scope de POST /invoices/{id}/charges/{charge_id}/pay.

invoices:settle

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Cobrança confirmada (paga)

`id`	string (uuid)
`status`	"pending" \| "paid" \| "cancelled" \| "expired" \| "failed"
`status_raw`	string	Status bruto do provider
`method`	"pix" \| "boleto" \| "checkout" \| "credit_card"
`provider`	"inter" \| "c6bank" \| "pix_offline" \| "pagarme" \| "cora"	Provedor resolvido. 'pix_offline' = Pix estático (BR Code local). 'pagarme' = Pix server-side ou cartão (method=credit_card retorna 'checkout.url' = link da página de pagamento). 'cora' = boleto ou Pix emitidos de forma síncrona (o boleto já volta com 'pdf_url').
`invoice_id`	string \| null (uuid)
`customer_id`	string \| null (uuid)
`amount`	number \| null
`due_date`	string \| null (date)
`pix`	object \| null
`boleto`	object \| null
`checkout`	object \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/charges/{id}/refund

Estornar cobrança (devolução Pix)

Estorna (devolve) uma cobrança Pix paga. Disponível apenas para Pix — boleto e checkout retornam 422. Requer que o endToEndId do pagamento tenha sido capturado. 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.

charges:refund

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Devolução solicitada

`id`	string
`status`	string
`provider`	string
`amount`	number
`message`	string

Exemplo

curl -X POST "https://api.comando.one/v1/charges/{id}/refund" \
  -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