API de Formas de pagamento do fornecedor

Cadastro de destinos de pagamento por fornecedor

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

GET/suppliers/{id}/payment-methods

Listar formas de pagamento do fornecedor

suppliers:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Formas de pagamento

`id`	string (uuid)
`supplier_id`	string (uuid)
`label`	string
`type`	"pix" \| "transfer" \| "boleto" \| "other"
`is_default`	boolean
`notes`	string \| null
`pix_key_type`	"cpf" \| "cnpj" \| "email" \| "phone" \| "random" \| null
`pix_key`	string \| null
`bank_code`	string \| null
`bank_name`	string \| null
`agency`	string \| null
`account_number`	string \| null
`account_type`	"corrente" \| "poupanca" \| null
`holder_name`	string \| null
`holder_document`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/suppliers/{id}/payment-methods

Cadastrar forma de pagamento

suppliers:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`type`obrigatório	"pix" \| "transfer" \| "boleto" \| "other"
`label`	string
`is_default`	boolean
`notes`	string
`pix_key_type`	"cpf" \| "cnpj" \| "email" \| "phone" \| "random"
`pix_key`	string	Obrigatório para type=pix
`bank_code`	string
`bank_name`	string
`agency`	string
`account_number`	string
`account_type`	"corrente" \| "poupanca"
`holder_name`	string
`holder_document`	string

Resposta 201 — Criada

`id`	string (uuid)
`supplier_id`	string (uuid)
`label`	string
`type`	"pix" \| "transfer" \| "boleto" \| "other"
`is_default`	boolean
`notes`	string \| null
`pix_key_type`	"cpf" \| "cnpj" \| "email" \| "phone" \| "random" \| null
`pix_key`	string \| null
`bank_code`	string \| null
`bank_name`	string \| null
`agency`	string \| null
`account_number`	string \| null
`account_type`	"corrente" \| "poupanca" \| null
`holder_name`	string \| null
`holder_document`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/suppliers/{id}/payment-methods" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"type":"<\"pix\" | \"transfer\" | \"boleto\" | \"other\">"}'

DELETE/suppliers/{id}/payment-methods/{methodId}

Excluir forma de pagamento

suppliers:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

`id`obrigatório(path)	string (uuid)
`methodId`obrigatório(path)	string (uuid)

Resposta 204 — Excluída

Sem corpo.

Exemplo

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

PATCH/suppliers/{id}/payment-methods/{methodId}

Atualizar forma de pagamento

suppliers:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

`id`obrigatório(path)	string (uuid)
`methodId`obrigatório(path)	string (uuid)

Corpo (JSON)

`type`obrigatório	"pix" \| "transfer" \| "boleto" \| "other"
`label`	string
`is_default`	boolean
`notes`	string
`pix_key_type`	"cpf" \| "cnpj" \| "email" \| "phone" \| "random"
`pix_key`	string	Obrigatório para type=pix
`bank_code`	string
`bank_name`	string
`agency`	string
`account_number`	string
`account_type`	"corrente" \| "poupanca"
`holder_name`	string
`holder_document`	string

Resposta 200 — Atualizada

`id`	string (uuid)
`supplier_id`	string (uuid)
`label`	string
`type`	"pix" \| "transfer" \| "boleto" \| "other"
`is_default`	boolean
`notes`	string \| null
`pix_key_type`	"cpf" \| "cnpj" \| "email" \| "phone" \| "random" \| null
`pix_key`	string \| null
`bank_code`	string \| null
`bank_name`	string \| null
`agency`	string \| null
`account_number`	string \| null
`account_type`	"corrente" \| "poupanca" \| null
`holder_name`	string \| null
`holder_document`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/suppliers/{id}/payment-methods/{methodId}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"type":"<\"pix\" | \"transfer\" | \"boleto\" | \"other\">"}'

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