webhook_auxilio_brasil

Webhook auxílio brasil

Criação de uma operação

Na criação de uma operação do Auxílio Brasil dentro do nosso sistema, são possíveis os seguintes status:

success: Informa o sucesso na consulta do benefício.
failure: Informa que ocorreu um erro na consulta do benefício.

Exemplos

Webhook de sucesso na consulta

body.json

{
    "callback": {
        "key": "bfbe918d-fe58-55a0-bdaf-5a3733b7a12d",
        "data": {
            "name": "LUIZ ANTONIO DA SILVA",
            "state": "RJ",
            "balance": "111",
            "family_code": 8553463416,
            "reference_date": "2022-08-03",
            "benefit_net_amount": 294,
            "benefit_total_amount": 294,
            "disbursement_bank_account": {
                "bank_code": "103",
                "account_digit": "5",
                "account_branch": "3880",
                "account_number": "000925559475"
            },
            "number_of_active_reservations": 0
        },
        "status": "success",
        "webhook_type": "social_benefit_balance",
        "event_datetime": "2022-08-29T20:47:48"
    }
}

Webhook de erro na consulta

body.json

{
    "callback": {
        "key": "5d85a8eb-94c1-4fcc-8f66-15b6301f6kfe",
        "data": {
            "enumerator": "not_found_family_member",
            "description": "there is not an active authorization for person"
        },
        "status": "failure",
        "webhook_type": "social_benefit_balance",
        "event_datetime": "2022-10-17T21:54:16"
    }
}

Enumerators	Descrição
`dataprev_error`	erro inesperado no Dataprev
`not_found_family_member`	não há uma autorização ativa para pessoa
`benefit_deleted`	benefício foi excluído

Cancelamento de uma operação

Existem alguns processos que cancelam uma operação de crédito, majoritariamente:

PIX/TED falhou ou foi estornado;
Passamos da data de desembolso;
Tentativa de averbação foi rejeitada;

Toda operação que está cancelada em nosso sistema pode voltar ao seu estado anterior através do método de mudança da data de desembolso. Alguns casos não são possíveis de voltarem ao estado inicial porque nunca será desembolsada, como é o caso 3, cuja tentativa de averbação foi rejeitada.

Para o primeiro caso:

body.json

{
    "key": "\<CHAVE DA OPERAÇÃO DE CRÉDITO\>",
    "data": {
        "pix_refusal": {
            "reason": "Número da conta de destino é inexistente ou inválido.",
            "reason_enumerator": "invalid_account"
        },
        "cancel_reason": "pix_refusal"
    },
    "status": "canceled",
    "webhook_type": "debt",
    "event_datetime": "2022-11-01 13:39:44"
}

A reason_enumerator pode ser conforme a lista abaixo:

Enumerators	Descrição
`invalid_document_number`	Documento inválido
`invalid_account`	Conta inválida
`unsupported_transaction`	Transação não suportada
`blocked_account`	Conta bloqueada
`closed_account`	Conta fechada
`rejected_payment`	Pagamento rejeitado
`amount_too_great`	Valor monetário muito alto
`spi_timeout`	Timeout do prestador de serviço
`receiver_error`	Erro do receptor
`incorrect_account_type`	Tipo de conta incorreta
`duplicity_of_payment_order`	Ordem de pagamento duplicado
`refund_after_unexpected_value`	Reembolso depois de valor inesperado
`refund_after_psp_error`	Reembolso depois de erros no PSP
`refund_after_technical_issues`	Reembolso depois de problemas técnicos
`refund_after_cancellation`	Reembolso depois de cancelamento
`refund_after_fraud`	Reembolso depois de fraude
`refund_after_payee_request`	Reembolso após solicitação do beneficiário
`refund_after_fraud_report`	Reembolso depois de relatório de fraude
`payee_not_in_allowed_list`	Beneficiário não se encontra na lista permitida
`payee_in_blocked_list`	Beneficiário se encontra na lista bloqueada
`unjustified_payment_order`	Ordem de pagamento não justificado

O segundo caso, ocorre quando algum processo interno dispara o cancelamento da Operação:

body.json

{
    "key": "\<CHAVE DA OPERAÇÃO DE CRÉDITO\>",
    "data": {
        "cancel_reason": "Operacao cancelada manualmente",
        "cancel_reason_enumerator": "manual"
    },
    "status": "canceled",
    "webhook_type": "debt",
    "event_datetime": "2022-11-01 03:46:31"
}

Aqui podemos ter os seguintes "cancel_reason_enumerators":

Cancel Reason Enumerators em rejeição de PAB:

Enumerators	Descrição
`social_benefit_ineligible_benefit`	Beneficio inelegível
`social_benefit_invalid_beneficiary_data`	Dados do beneficiário inválidos
`social_benefit_invalid_balance`	Margem indisponível
`social_benefit_contract_limit_exceeded`	O cliente não pode ter mais contratos
`social_benefit_installments_limit_exceeded`	O cliente não pode ter esse numero de parcelas em um contrato
`social_benefit_invalid_disbursement_account`	Conta divergente com o DataPrev

Cancel Reason Enumerators mudança de dia

Enumerators	Descrição
`not_collateral_constituted_social_benefit`	Mudou de dia e a operação não teve a garantia averbada
`waiting_signature`	Mudou de dia e a operação não foi assinada
`not_assigned`	Mudou de dia e a CCB está configurada para desembolsar após a cessão, mas nao foi cedida
`disburse_is_not_allowed`	Mudou de dia e a CCB está configurada com o fluxo de "Liberar o desembolso" mas não foi liberado
`manual`	Mudou de dia e a operação não foi desembolsada.

Os cancel reason começados com "social_benefit" são permanentes, então a reserva foi de fato rejeitada. Mas em relação aos outros, ainda podem retornar ao estado inicial então deve ser devidamente analisado.

Webhook auxílio brasil​

Webhook auxílio brasil