Pagamentos
As tentativas de liquidação de uma fatura: retentativa, troca de cartão, mudança de vencimento, estorno e reenvio do e-mail de cobrança.
| Comando | HTTP | Descrição |
|---|---|---|
payments list | GET /v1/payments | Listar pagamentos |
payments create | POST /v1/payments | Processar pagamento |
payments get | GET /v1/payments/{id} | Obter pagamento |
payments delete | DELETE /v1/payments/{id} | Excluir pagamento |
payments cancel | POST /v1/payments/{id}/cancel | Cancelar pagamento |
payments change-card | POST /v1/payments/{id}/change-card | Trocar cartão do pagamento |
payments change-due-date | POST /v1/payments/{id}/change-due-date | Alterar vencimento do boleto |
payments refund | POST /v1/payments/{id}/refund | Estornar pagamento |
payments retry | POST /v1/payments/{id}/retry | Tentar pagamento novamente |
payments send-email | POST /v1/payments/{id}/send-email | Enviar boleto por e-mail |
payments sync | POST /v1/payments/{id}/sync | Sincronizar pagamento com gateway |
payments bulk-update-invoice create | POST /v1/payments/bulk-update-invoice | Reatribuir pagamentos a outra fatura |
Exemplos
--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.
# Listar pagamentos
kobana billing payments list \
--fields "id,public_id,external_id,invoice_id,billing_account_id"
# Obter pagamento
kobana billing payments get --params '{"id": "PAYMENT_ID"}'
# Processar pagamento
kobana billing payments create --json '{"invoiceId": "INVOICEID"}'
# Cancelar pagamento
kobana billing payments cancel \
--params '{"id": "PAYMENT_ID"}' \
--json '{"reason": "REASON", "cancel_on_gateway": true}'
# Excluir pagamento
kobana billing payments delete --params '{"id": "PAYMENT_ID"}' --dry-run
Próximos passos
- Meios de pagamento
- Introspecção de schema — todos os parâmetros que este recurso aceita.