Pagamentos
Contas a pagar: boletos de terceiros, Pix, tributos e concessionárias, os lotes, a aprovação, as contas de pagamento e o DDA.
Pagamentos por tipo
Pagamento de boletos, Pix, tributos e concessionárias, lotes, aprovação, contas de pagamento e DDA.
| Comando | HTTP | Descrição |
|---|---|---|
payment accounts list | GET /v2/payment/accounts | Listar Contas de Pagamento |
payment accounts get | GET /v2/payment/accounts/{uid} | Buscar Conta de Pagamento |
payment bank-billet-batches create | POST /v2/payment/bank_billet_batches | Criar um Lote de Pagamento de Boletos |
payment bank-billets list | GET /v2/payment/bank_billets | Listar Pagamentos de Boleto |
payment bank-billets create | POST /v2/payment/bank_billets | Criar um Pagamento de Boleto |
payment bank-billets get | GET /v2/payment/bank_billets/{uid} | Visualizar um Pagamento de Boleto |
payment bank-billets cancel | PUT /v2/payment/bank_billets/{uid}/cancel | Cancelar um Pagamento de Boleto |
payment batches list | GET /v2/payment/batches | Listar Lotes de Pagamentos |
payment batches get | GET /v2/payment/batches/{uid} | Visualizar um Lote de Pagamento |
payment batches approve | PUT /v2/payment/batches/{uid}/approve | Aprovar um Lote de Pagamento |
payment batches reprove | PUT /v2/payment/batches/{uid}/reprove | Reprovar um Lote de Pagamento |
payment dda-accounts list | GET /v2/payment/dda_accounts | Listar Contas de DDA |
payment dda-accounts create | POST /v2/payment/dda_accounts | Criar Conta de DDA |
payment dda-accounts get | GET /v2/payment/dda_accounts/{uid} | Buscar Conta de DDA |
payment dda-accounts update | PUT /v2/payment/dda_accounts/{uid} | Atualizar Conta de DDA |
payment dda-accounts disable | PUT /v2/payment/dda_accounts/{uid}/disable | Desabilitar Conta de DDA |
payment dda-accounts enable | PUT /v2/payment/dda_accounts/{uid}/enable | Habilitar Conta de DDA |
payment dda-bank-billets list | GET /v2/payment/dda_bank_billets | Listar Boletos DDA |
payment dda-bank-billets get | GET /v2/payment/dda_bank_billets/{uid} | Buscar Boleto DDA |
payment dda-bank-billets delete | DELETE /v2/payment/dda_bank_billets/{uid} | Excluir Boleto DDA |
payment dda-bank-billets reject | PUT /v2/payment/dda_bank_billets/{uid}/reject | Rejeitar Boleto DDA |
payment dda-bank-billets release | PUT /v2/payment/dda_bank_billets/{uid}/release | Liberar Boleto DDA para Pagamento |
payment pix list | GET /v2/payment/pix | Listar Pagamentos Pix |
payment pix create | POST /v2/payment/pix | Criar um Pagamento Pix |
payment pix get | GET /v2/payment/pix/{uid} | Visualizar um Pagamento Pix |
payment pix cancel | PUT /v2/payment/pix/{uid}/cancel | Cancelar um Pagamento Pix |
payment pix-batches create | POST /v2/payment/pix_batches | Criar um Lote de Pagamento Pix |
payment tax-batches create | POST /v2/payment/tax_batches | Criar Lote de Pagamentos de Tributo |
payment taxes list | GET /v2/payment/taxes | Listar Pagamentos de Tributo |
payment taxes create | POST /v2/payment/taxes | Criar Pagamento de Tributo |
payment taxes get | GET /v2/payment/taxes/{uid} | Exibir Pagamento de Tributo |
payment taxes cancel | PUT /v2/payment/taxes/{uid}/cancel | Cancelar um Pagamento de Tributo |
payment utilities list | GET /v2/payment/utilities | Listar Pagamentos de Contas de Consumo |
payment utilities create | POST /v2/payment/utilities | Criar um Pagamento de Conta de Consumo |
payment utilities get | GET /v2/payment/utilities/{uid} | Visualizar um Pagamento de Conta de Consumo |
payment utilities cancel | PUT /v2/payment/utilities/{uid}/cancel | Cancelar um Pagamento de Conta de Consumo |
payment utility-batches create | POST /v2/payment/utility_batches | Criar um Lote de Pagamento de Contas de Consumo |
# Listar Contas de Pagamento
kobana banking payment accounts list
# Buscar Conta de Pagamento
kobana banking payment accounts get --params '{"uid":"ACCOUNT_UID"}'
# Cancelar um Pagamento de Boleto
kobana banking payment bank-billets cancel --params '{"uid":"BANK_BILLET_UID"}' --dry-run
Pagamentos (unificado)
Todos os pagamentos, de qualquer tipo, numa listagem só.
| Comando | HTTP | Descrição |
|---|---|---|
payments list | GET /v2/payments | Listar Pagamentos |
payments create | POST /v2/payments | Criar um Pagamento |
payments get | GET /v2/payments/{uid} | Visualizar um Pagamento |
payments cancel | PUT /v2/payments/{uid}/cancel | Cancelar um Pagamento |
# Listar Pagamentos
kobana banking payments list
# Visualizar um Pagamento
kobana banking payments get --params '{"uid":"PAYMENT_UID"}'
# Cancelar um Pagamento
kobana banking payments cancel --params '{"uid":"PAYMENT_UID"}' --dry-run
Próximos passos
- Introspecção de schema: os parâmetros e o corpo que cada comando aceita.
- Flags globais:
--params,--json,--fields,--dry-rune as demais.