Solicitações de autorização
A solicitação é o pedido de autorização de uma recorrência enviado ao banco do pagador. O banco do pagador mostra o pedido no aplicativo dele, e o pagador aceita ou rejeita. É a jornada Notificação Externa da recorrência.
A solicitação é gerenciada pela API v2.
Antes de começar
A recorrência precisa estar registrada no banco. Uma solicitação para uma recorrência ainda sem registro é recusada com "deve estar registrada no provedor financeiro".
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Recorrência | Sim | Recorrência a ser autorizada. A conta Pix Automático vem dela. |
| Data de Expiração | Sim | Prazo da solicitação. Precisa ser de hoje em diante. |
| Destinatário da Solicitação (Usuário Pagador) | Sim | Conta do pagador que recebe o pedido: banco (ISPB), agência, número e dígito da conta, tipo de conta e titular (tipo e número do documento e nome). O dígito da conta é obrigatório. |
| ID Externo | Não | Identificador do seu sistema. Não pode se repetir na mesma conta Kobana. |
| Etiquetas e Dados Personalizados | Não | Informações livres para organizar e buscar. |
Situação no Provedor
| Situação | O que significa |
|---|---|
| Pendente | Criada na Kobana, ainda sem registro no banco |
| Criado | Registrada no banco |
| Enviado | Enviada ao banco do pagador |
| Recebido | Recebida pelo banco do pagador |
| Aceito | O pagador aceitou |
| Rejeitado | O pagador ou o banco dele recusou |
| Expirado | A solicitação expirou |
| Cancelado | A solicitação foi cancelada |
Pendente ─► Criado ─► Enviado ─► Recebido ─► Aceito
Antes de Aceito, a solicitação pode ir para Rejeitado ou Expirado. Até Aceito, inclusive, pode ir para Cancelado. Se o banco informar diretamente uma situação mais adiantada, a Kobana registra as etapas intermediárias.
Quando há rejeição, a solicitação guarda o código e a descrição. Alguns códigos:
| Código | Motivo |
|---|---|
| AC01 | Conta não localizada ou não pertencente ao pagador |
| AC04 | Conta transacional do pagador encerrada |
| AC06 | Conta transacional do pagador bloqueada |
| AP02 | CPF/CNPJ do pagador não localizado ou divergente |
| AP13 | Rejeição do pagador por não reconhecimento do recebedor |
| AP14 | Rejeição do pagador por falta de interesse no Pix Automático |
| AP15 | PSP do pagador não oferece Pix Automático para PJ |
| SA01 | Uso de conta-salário não permitido para cobranças recorrentes |
Cancelar uma solicitação
Pela API, uma solicitação registrada no banco e ainda não rejeitada, expirada nem cancelada pode ser cancelada. A Kobana envia um comando de cancelamento ao banco, e a situação passa a Cancelado quando o banco confirma. Comandos ainda agendados para a mesma solicitação são interrompidos.
Eventos de webhook
| Código | Quando |
|---|---|
charge.automatic_pix.request.db.created, .db.updated, .db.deleted | Solicitação criada, alterada ou excluída na Kobana |
charge.automatic_pix.request.register.requested, .confirmed, .failed, .error | Andamento do registro no banco |
charge.automatic_pix.request.cancel.requested, .confirmed, .failed, .error | Andamento do cancelamento no banco |
charge.automatic_pix.request.pending, .created, .sent, .received, .accepted, .rejected, .expired, .canceled | Mudança da Situação no Provedor |
Pela API
Solicitações de autorização estão na API v2.