Webhooks de indevidos

Informação

O timeout para resposta de nossos webhooks é de 5 segundos.

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Introdução

Estes webhooks são disparados automaticamente quando a QI Tech identifica e processa a devolução de um valor indevido.

Webhook de sucesso na devolução de indevidos

Response Body

{
    {
        "event_datetime": "2024-01-15T14:30:00.000Z",
        "key": "fb34e0ac-2c98-47e7-9040-406b8c3d80e7",
        "status": "refunded",
        "webhook_type": "laas.devolution.refund_receipt",
        "data": {
            "origin_key":"b41c63e4-6912-4217-9111-a47dd4da9588",
            "devolution_key": "336f0e15-e7b8-45a4-8986-5411434be76a",
            "devolution_amount": 150.75,
            "devolution_status": "refunded",
            "devolution_reason_description": "The payment arrived earlier than expected. The difference between the paid amount and the present value should be refund",
            "receipt_url": "https://storage.googleapis.com/receipts/devolution_receipt_12345.pdf",
            "document_key": "cd27a0c3-630d-4682-81b2-71b5b325bcde",
            "transacted_at": "2024-01-15T14:25:30.000Z",
            "devolution_origin_type":"social_security"
        }
    }
}

Webhook de falha na devolução de indevidos

Response Body

{
    {
        "event_datetime": "2024-01-15T14:30:00.000Z",
        "key": "fb34e0ac-2c98-47e7-9040-406b8c3d80e7",
        "status": "error",
        "webhook_type": "laas.devolution.refund_failed",
        "data": {
            "origin_key":"b41c63e4-6912-4217-9111-a47dd4da9588",
            "devolution_key": "336f0e15-e7b8-45a4-8986-5411434be76a",
            "devolution_amount": 150.75,
            "devolution_status": "error",
            "devolution_reason_description": "The payment arrived earlier than expected. The difference between the paid amount and the present value should be refund",
            "devolution_origin_type":"social_security"
        }
    }
}

Retentativa de devolução

No caso de falha na devolução, é possível realizar uma chamada para retentar a transferência.

Enviando os dados bancários, será feita a retentativa inicialmente por pix na conta informada, no caso de falha, será realizada uma segunda tentativa através de chave pix cpf. É possível realizar a retentativa diretamente por chave pix cpf.

PATCH

/devolution/devolution/DEVOLUTION-KEY/retry

Request Body

Informando dados bancários
Por chave pix cpf

{
    "issuer_name":"John Doe",
    "document_number": "14471835092",
    "bank_account": {
      "account_branch":"0001",
      "account_number":"12345",
      "account_digit":"9",
      "bank_code":"001",
      "ispb":"00000000",
      "account_type":"checking"
    },
}

{ 
    "use_only_document_number_pix_key": true
}

Definições

Objeto callback

Campo	Tipo	Descrição	Obrigatório
event_datetime	string	Data e hora do evento no formato ISO 8601 UTC	Sim
key	string	Chave única da devolução	Sim
status	string	Status da devolução	Sim
webhook_type	string	Tipo do webhook	Sim
data	object	Dados específicos da devolução	Sim

Objeto data

Campo	Tipo	Descrição	Obrigatório
origin_key	string	Chave de referência do recurso devolvido	Sim
devolution_key	string	Chave única da devolução	Sim
devolution_amount	number	Valor da devolução em reais	Sim
devolution_status	string	Status atual da devolução	Sim
devolution_reason_description	string	Descrição do motivo da devolução	Sim
receipt_url	string	URL do comprovante da devolução	Sim
document_key	string	Chave do documento relacionado	Sim
transacted_at	string	Data e hora da transação no formato ISO 8601 UTC	Sim
devolution_origin_type	string	Origem do recurso da devolução, consulte os possíveis enumeradores na tabela Possíveis enumeradores de devolution_origin_type	Sim

Possíveis enumeradores de devolution_origin_type

Status	Descrição
fgts_conciliation	Desconto indevido associado ao repasse de FGTS
ss_conciliation	Desconto indevido associado ao repasse de INSS
private_payroll_conciliation	Desconto indevido associado ao repasse de Consignado Privado
military_payroll_conciliation	Desconto indevido associado ao repasse de Exército
federal_payroll_conciliation	Desconto indevido associado ao repasse de SIAPE
payroll_card_discount	Desconto indevido associado ao repasse de Cartão Consignado
renegotiation	Desconto indevido associado a renegociação

Status possíveis

Status	Descrição
refunded	Devolução processada com sucesso
error	Devolução processada com sucesso

Introdução​

Webhook de sucesso na devolução de indevidos​

Webhook de falha na devolução de indevidos​

Retentativa de devolução

Definições​

Objeto callback​

Objeto data​

Possíveis enumeradores de devolution_origin_type​

Status possíveis​