Simulação de Cenários

Passo a passo para simular a efetivação de ações feitas por agentes externos. Essas simulações incluem recebimentos e atualizações de relatos de infração .

Informação

Não há payload de retorno (response body) nessas requisições, somente response status de 204. O conteúdo gerado pelo mock deve ser recebido via webhook.

1 - Simulação de recebimento de relato de infração

Simula o recebimento de um relato de infração aberto por outra instituição.

IMPORTANTE

É essencial possuir uma pix_transfer_key válida para mandar a request, não importando necessariamente as informações da outra parte da transferencia, visto que todas as informações do segundo participante serão substituidas no processo de mock.

Request

ENDPOINT

/mock/pix/infraction_report

MÉTODO

POST

Request Body

{
  "infraction_report_status": "acknowledged",
  "pix_transfer_key": "28290ff2-2ba7-4e85-9a5e-862c92259b33",
  "infraction_report_type": "refund_request",
  "infraction_report_situation": "scam",
  "infraction_report_details": "Transação com suspeita de fraude.",
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
infraction_report_status*	string	Status de recebimento do relato de infração. "acknowledged".	Enumeradores infraction_report_status
pix_transfer_key*	string	UUID4, chave única que identifica a transação relacionada.	36
infraction_report_type*	string	Tipo de Relato de Infração	Enumeradores infraction_report_type
infraction_report_situation*	string	Situação em que ocorreu a infração	Enumeradores infraction_report_situation
infraction_report_details*	string	Detalhes do relato de infração	2000

Enumeradores infraction_report_status

Campo	Tipo	Descrição	Caracteres
open	string	Relato de infração foi criado e está aberto no BACEN.	-
acknowledged	string	Relato de infração foi recebido pelo participante	-
cancelled	string	Relato de infração está cancelado no BACEN	-
closed	string	Relato de infração está fechado no BACEN	-

Enumeradores infraction_report_type

Campo	Tipo	Descrição	Caracteres
refund_request	string	Relato de infração será gerado a fim de se solicitar uma devolução.	-
refund_cancelled	string	Relato de infração será gerado pelo motivo de uma devolução cancelada.	-

Enumeradores infraction_report_situation

Campo	Tipo	Descrição	Caracteres
scam	string	Causa de golpe ou estelionato.	-
account_takeover	string	Causa de transação não autorizada pela conta de origem.	-
coercion	string	Causa de crime de coerção.	-
fraudulent_access	string	Causa de acesso fraudulento à conta de origem.	-
other	string	Quaisquer causas não aplicáveis às listadas acima.	-

2 - Simulação de atualização de um relato de infração

Simula a atualização de status de um relato de infração aberto pelo participante indireto.

As opções de simulação para atualização de um relato de infração são:

1 - Cancelamento: Simula o cancelamento (cancel), feito pelo outro participante, sobre um relato de infração aberto por ele mesmo previamente.

2 - Fechamento: Simula o fechamento (close), feito pelo outro participante, sobre um relato de infração aberto pelo participante indireto.

Request

ENDPOINT

/mock/pix/infraction_report

MÉTODO

PATCH

Request Body - Cancelamento

IMPORTANTE

O Relato de infração identificado pela infraction_report_key ja deve ter sido previamente criado na simulação de recebimento de relato de infração.

{
  "infraction_report_status": "cancelled",
  "infraction_report_key": "28290ff2-2ba7-4e85-9a5e-862c92259b34"
}

Request Body - Fechamento

IMPORTANTE

O Relato de infração identificado pela infraction_report_key ja deve ter sido previamente criado pelo participante indireto, e reconhecido na simulação de atualização de um relato de infração.

{
  "infraction_report_status": "closed",
  "infraction_report_key": "28290ff2-2ba7-4e85-9a5e-862c92259b34",
  "analysis_result": "agreed",
  "analysis_details": "Valor bloqueado. Para mais informações ligue para (99) 99999-9999."
}

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.	Informações
infraction_report_status*	string	Novo status do relato de infração. "cancelled", "closed"	Enumeradores infraction_report_status	----
infraction_report_key*	string	Chave única do relato de infração	36	----
analysis_result*	string	Resultado da análise do relato de infração. "agreed" ou "disagreed".	Enumeradores analysis_result	Obrigatório para status "closed"
analysis_details*	string	Detalhes da análise do relato de infração.	2000	Obrigatório para status "closed"

Enumeradores analysis_result

Campo	Tipo	Descrição	Caracteres
agreed	string	O Participante Indireto concorda com o Relato de Infração criado pelo outro Participante.	-
disagreed	string	O Participante Indireto discorda com o Relato de Infração criado pelo outro Participante.	-