Pix e Pix Automático
A família charge da API v2: cobranças Pix, contas Pix, Pix Automático e o recebimento unificado.
Cobranças (v2)
Cobranças Pix com QR Code e os seus comandos, as contas Pix, o Pix Automático (contas, locations, recorrências, solicitações e cobranças) e os recebimentos.
| Comando | HTTP | Descrição |
|---|---|---|
charge automatic-pix accounts list | GET /v2/charge/automatic_pix/accounts | Lista todas as contas PIX automáticas |
charge automatic-pix accounts create | POST /v2/charge/automatic_pix/accounts | Criar nova conta PIX automática |
charge automatic-pix accounts get | GET /v2/charge/automatic_pix/accounts/{uid} | Visualizar conta PIX automática |
charge automatic-pix accounts update | PATCH /v2/charge/automatic_pix/accounts/{uid} | Atualizar conta PIX automática |
charge automatic-pix accounts delete | DELETE /v2/charge/automatic_pix/accounts/{uid} | Excluir conta PIX automática |
charge automatic-pix locations list | GET /v2/charge/automatic_pix/locations | Lista todas as Locations do Pix Automático |
charge automatic-pix locations create | POST /v2/charge/automatic_pix/locations | Criar nova Location do PIX Automático |
charge automatic-pix locations get | GET /v2/charge/automatic_pix/locations/{uid} | Consulta uma Location do PIX Automático específica |
charge automatic-pix pix list | GET /v2/charge/automatic_pix/pix | Lista todas as cobranças PIX automáticas |
charge automatic-pix pix get | GET /v2/charge/automatic_pix/pix/{uid} | Informações da cobrança PIX automática |
charge automatic-pix pix update | PATCH /v2/charge/automatic_pix/pix/{uid} | Atualizar cobrança PIX automática |
charge automatic-pix pix cancel | PUT /v2/charge/automatic_pix/pix/{uid}/cancel | Cancelar cobrança PIX automática |
charge automatic-pix pix retry | PUT /v2/charge/automatic_pix/pix/{uid}/retry | Retentar cobrança PIX automática |
charge automatic-pix recurrences list | GET /v2/charge/automatic_pix/recurrences | Lista todas as recorrências PIX automáticas |
charge automatic-pix recurrences create | POST /v2/charge/automatic_pix/recurrences | Criar nova recorrência PIX automática |
charge automatic-pix recurrences pix | POST /v2/charge/automatic_pix/recurrences/{recurrence_uid}/pix | Criar nova cobrança PIX automática |
charge automatic-pix recurrences requests | POST /v2/charge/automatic_pix/recurrences/{recurrence_uid}/requests | Criar nova solicitação PIX automática |
charge automatic-pix recurrences get | GET /v2/charge/automatic_pix/recurrences/{uid} | Informações da recorrência PIX automática |
charge automatic-pix recurrences update | PATCH /v2/charge/automatic_pix/recurrences/{uid} | Atualizar recorrência PIX automática |
charge automatic-pix recurrences cancel | PUT /v2/charge/automatic_pix/recurrences/{uid}/cancel | Cancelar recorrência PIX automática |
charge automatic-pix requests list | GET /v2/charge/automatic_pix/requests | Lista todas as solicitações PIX automáticas |
charge automatic-pix requests get | GET /v2/charge/automatic_pix/requests/{uid} | Informações da solicitação PIX automática |
charge automatic-pix requests update | PATCH /v2/charge/automatic_pix/requests/{uid} | Atualizar solicitação PIX automática |
charge automatic-pix requests cancel | PUT /v2/charge/automatic_pix/requests/{uid}/cancel | Cancelar solicitação PIX automática |
charge payments list | GET /v2/charge/payments | Listar Recebimentos |
charge payments create | POST /v2/charge/payments | Informar Recebimento |
charge payments get | GET /v2/charge/payments/{uid} | Informações do Recebimento |
charge payments delete | DELETE /v2/charge/payments/{uid} | Excluir Recebimento |
charge pix list | GET /v2/charge/pix | Listar Pix |
charge pix create | POST /v2/charge/pix | Criar um Pix |
charge pix cancel | PUT /v2/charge/pix/{pix_uid}/cancel | Cancelar um Pix |
charge pix update | PUT /v2/charge/pix/{pix_uid}/update | Atualizar um Pix |
charge pix get | GET /v2/charge/pix/{uid} | Visualizar um Pix |
charge pix delete | DELETE /v2/charge/pix/{uid} | Excluir um Pix |
charge pix commands get | GET /v2/charge/pix/{pix_uid}/commands/{id} | Visualizar um Comando |
charge pix-accounts list | GET /v2/charge/pix_accounts | Listar Contas Pix |
charge pix-accounts create | POST /v2/charge/pix_accounts | Criar Pix Account |
charge pix-accounts get | GET /v2/charge/pix_accounts/{uid} | Visualizar uma conta Pix |
charge pix-accounts update | PUT /v2/charge/pix_accounts/{uid} | Atualizar Pix Account |
charge pix-accounts delete | DELETE /v2/charge/pix_accounts/{uid} | Deletar Pix Account |
# Lista todas as contas PIX automáticas
kobana banking charge automatic-pix accounts list
# Visualizar conta PIX automática
kobana banking charge automatic-pix accounts get --params '{"uid":"ACCOUNT_UID"}'
# Excluir conta PIX automática
kobana banking charge automatic-pix accounts delete --params '{"uid":"ACCOUNT_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.