Webhook de conclusão de Agendamento Pix

Após a conclusão de um agendamento Pix, um webhook será enviado ao parceiro integrador com o resultado.

Atenção!

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

Webhook Request Body

Request Body: Agendamento Concluído e Enviado

{
  "webhook_type": "baas.pix_schedule.completed",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "created_at": "2024-07-10T16:17:28Z",
    "pix_message": null,
    "rejection_info": null,
    "rejection_reason": null,
    "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de5001",
    "schedule_date": "2024-07-10",
    "schedule_key": "0c9091ab-079b-4a43-8b3d-d4ba36a23883",
    "schedule_status": "sent",
    "schedule_transfers": [
      {
        "created_at": "2024-07-10T16:19:33Z",
        "end_to_end_id": "E3240250220240710161922sSHNf8BjI",
        "pix_transfer_key": "427b70cd-73b0-45d1-bb4a-97f50f605022",
        "pix_transfer_status": "sent"
      }
    ],
    "target_account": {
      "account_branch": "0001",
      "account_digit": "8",
      "account_number": "1234567",
      "account_type": "checking_account",
      "ispb": "99999004",
      "owner_document_number": "***91111***",
      "owner_name": "Conta manual geral",
      "owner_person_type": "natural",
      "pix_key": null,
      "receiver_conciliation_id": null
    },
    "transaction_amount": 2.0,
    "updated_at": "2024-07-10T16:19:38Z"
  }
}

Request Body: Agendamento Concluído e Rejeitado

{
  "created_at": "2024-07-11T16:03:54Z",
  "pix_message": null,
  "rejection_info": {
    "error_code": "PSC000030",
    "error_description": "The maximum amount of pix transfer attempts has been reached",
    "error_translation": "A maxima quantidade de retentativas de transacao pix foi atingida",
    "rejection_reason": "max_tries_exceeded"
  },
  "rejection_reason": null,
  "request_control_key": "b8eb663e-10fe-4729-9db5-8f8c93de0008",
  "schedule_date": "2024-07-11",
  "schedule_key": "8b262d82-3fc6-40f0-bfe5-bf18556ededb",
  "schedule_status": "rejected",
  "schedule_transfers": [
    {
      "created_at": "2024-07-11T16:04:21Z",
      "end_to_end_id": "E32402502202407111604ffoPVrGebI0",
      "pix_transfer_key": "c2c4e064-e684-450b-add5-07fb1efe8991",
      "pix_transfer_status": "rejected"
    },
    {
      "created_at": "2024-07-11T16:08:33Z",
      "end_to_end_id": "E32402502202407111608TQ3C4vRPRPk",
      "pix_transfer_key": "c30254db-86b2-4d8a-be01-29fa0d93ae92",
      "pix_transfer_status": "rejected"
    },
    {
      "created_at": "2024-07-11T16:09:20Z",
      "end_to_end_id": "E32402502202407111609zSUQQOvmMV6",
      "pix_transfer_key": "1a329248-fc39-4b49-9b95-8f1c1bb10c8b",
      "pix_transfer_status": "rejected"
    }
  ],
  "target_account": {
    "account_branch": "0001",
    "account_digit": "8",
    "account_number": "1234567",
    "account_type": "checking_account",
    "ispb": "99999004",
    "owner_document_number": "***91111***",
    "owner_name": "Conta manual geral",
    "owner_person_type": "natural",
    "pix_key": null,
    "receiver_conciliation_id": null
  },
  "transaction_amount": 2.0,
  "updated_at": "2024-07-11T16:09:21Z"
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
transaction_amount	number	Valor da transferencia	10
target_account	object	Conta destino do agendamento	Objeto target_account
schedule_transfers	array	Lista de tentativas de transferências realizadas pelo agendamento	lista de Objeto schedule_transfer
schedule_status	string	Status do agendamento	Enumerador schedule_status
schedule_key	string	Chave única de identificação do agendamento	36
schedule_date	string	Data a ser realizada a transação.	10
request_control_key	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4.	36
rejection_info	object	Objeto com informaçôes sobre o evento de rejeição
rejection_reason	string	Motivo da rejeição	Enumeradores rejection_reason
pix_message	string	Mensagem a ser enviada junto à transferência Pix	140
updated_at	string	Data e hora da última atualização do agendamento.	20
created_at	string	Data e hora de criação do agendamento.	20

Pix Schedule Status

Enumerador	Descrição
scheduled	Transação agendada
sent	Agendamento concluído e enviado com sucesso. Estado final
rejected	Agendamento rejeitado durante criação ou execução. Estado final
cancelled	Agendamento cancelado por solicitação de cliente. Estado final
pending_2fa_approval	Pendente de aprovação por autenticação de dois fatores
pending_creation	Agendamento em processo de criação (Estado transitório para agendamento em lote)
waiting_batch_approval	Agendamento criado e vinculado a um lote aguardando aprovação por autenticação de dois fatores

Schedule Transfer Object

Campo	Tipo	Descrição	Caracteres
pix_transfer_key	uuidv4	Chave única de identificação da transferência Pix no sistema QI.	36
end_to_end_id *	string	Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo)	32
pix_transfer_status	string	Status da transação.	Enumeradores pix_transfer_status
created_at	string	Data e hora de criação da transação.	20

Enumerador Pix Transfer Status

Enumerador	Descrição
sent	Transação enviada com sucesso. Estado final
rejected	Transação rejeitada durante execução. Estado final
pending	Transação pendente de conclusão. Estado Transitório

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch	string	Agência da conta	6
account_digit	string	Dígito da conta	1
account_number	string	Número da conta	20
owner_document_number	string	CPF ou CNPJ (apenas números) do titular da conta	14
owner_name	string	Nome do titular da conta	150
owner_person_type	enumerator	Identificador de que o dono da conta enviada é uma pessoa física ou jurídica	Enumerador owner_person_type
owner_name	string	Nome do titular da conta	150
account_type	enumerator	Tipo da conta	Enumerador account_type
ispb	string	Código de oito dígitos que identifica os bancos no sistema de transferência de reserva do Banco Central	8
pix_key	string	Chave pix alvo do agendamento	100

Enumerador owner_person_type

Enum	Description
natural	Pessoa física
legal	Pessoa jurídica

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

Enumeradores rejection_reason

Enumerador	Descrição
target_creation_error	Erro na criação do agendamento
limit_date_for_approval_surpassed	Data limite para aprovação ultrapassada
limit_date_for_batch_approval_surpassed	Data limite para aprovação de lote ultrapassada
max_tries_exceeded	Número máximo de tentativas excedido
rejection_by_transfer	Rejeição pela transferência
target_change	Mudança na conta destino
invalid_pix_key	Chave Pix inválida
max_token_validation_attempts_exceeded	Número máximo de tentativas de validação de token excedido
error_sending_token	Erro ao enviar token
max_token_validation_attempts_exceeded_for_batch	Número máximo de tentativas de validação de token para lote excedido