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 solicitações de devolução.
Não há payload de retorno (response body) nessas requisições, somente response status de 201.
1 - Simulação de recebimento de solicitação de devolução
Simula o recebimento de uma solicitação de devolução aberta por outra instituição.
É 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
Request Body
Caso o tipo de devolução seja de FRAUD, é necessário haver um relato de infração fechado para a mesma pix_transfer_key.
{
"pix_transfer_key": "d5856a5f-378f-43ed-818b-df33b9fae703",
"refund_request_type": "fraud",
"refund_request_details": "Foi identificada uma fraude na transação.",
"refund_request_status": "open",
}
Objeto Request Body
| Campo | Tipo | Descrição | Máx. Caract. |
|---|---|---|---|
pix_transfer_key * | string | Chave de identificação da transferência Pix no sistema QI (UUIDv4) | 36 |
refund_request_type * | enum | Tipo de solicitação de devolução. | Enumeradores refund_request_type |
refund_request_status * | string | Status inicial da solicitação de devolução. "open" | 36 |
refund_request_details | string | Detalhes do relato da solicitação de devolução | 2000 |
Enumeradores refund_request_type
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
fraud | string | Solicitação de Devolução originada de uma fraude. | 5 |
operational_flaw | string | Solicitação de Devolução originada de um erro interno. | 16 |
2 - Simulação de atualização de uma solicitação de devolução
Simula a atualização de status de uma solicitação de devolução aberta pelo participante indireto.
As opções de simulação para atualização de uma solicitação de devolução são:
1 - Cancelamento: Simula o cancelamento (cancel), feito por um participante "alvo", sobre uma solicitação de devolução aberta por ele mesmo previamente.
2 - Fechamento: Simula o fechamento (close), feito por um participante "alvo", sobre uma solicitação de devolução aberta pelo participante indireto. É importante que esse relato ja tenha sido reconhecido aberto.
Request
Request Body - Cancelamento
A Solicitação de devolução identificada pela refund_request_key ja deve ter sido previamente criada na simulação de criação de solicitação de devolução.
{
"refund_request_status": "cancelled",
"refund_request_key": "c3e5664f-04bb-4625-9ef3-c8555d210c71"
}
Request Body - Fechamento com Aceite Total
A Solicitação de devolução identificada pela refund_request_key ja deve ter sido previamente criado pelo participante indireto.
A refund transfer key deve ter sido préviamente criada pelo mock de recebimento de devolução com valor IGUAL à transação original.
{
"refund_request_key": "42035bdd-0551-41c5-aaae-cb27d108160a",
"refund_request_status": "closed",
"analysis_result": "totally_accepted",
"analysis_details": "Teste",
"refund_transfer_key": "6f421127-892f-415f-8efc-4e20cf5d622d"
}
Request Body - Fechamento com Aceite Parcial
A Solicitação de devolução identificada pela refund_request_key ja deve ter sido previamente criado pelo participante indireto. Além disso, o valor devolvido não deve ser igual ou superior ao valor total da transação original.
A refund transfer key deve ter sido préviamente criada pelo mock de recebimento de devolução com valor MENOR à transação original.
{
"refund_request_key": "42035bdd-0551-41c5-aaae-cb27d108160a",
"refund_request_status": "closed",
"analysis_result": "partially_accepted",
"analysis_details": "Teste",
"refund_transfer_key": "6f421127-892f-415f-8efc-4e20cf5d622d"
}
Request Body - Fechamento com Recusa
A Solicitação de devolução identificada pela refund_request_key ja deve ter sido previamente criado pelo participante indireto.
{
"refund_request_key": "47633091-7d44-4d10-9d00-1f937104e537",
"refund_request_status": "closed",
"analysis_result": "rejected",
"analysis_details": "Teste",
"reject_reason": "no_balance"
}
Objeto Request Body
| Campo | Tipo | Descrição | Máx. Caract. |
|---|---|---|---|
refund_request_status * | string | Status inicial da solicitação de devolução. "cancelled", "closed" | 36 |
refund_request_key * | string | Chave única da solicitação de devolução | 36 |
analysis_result * | string | Resultado da análise da solicitação de devolução. "totally_accepted" ou "partially_accepted", "rejected". | 36 |
analysis_details | string | Detalhes da análise da solicitação de devolução | 2000 |
refund_transfer_key | float | Identificador da transferência de devolução, obrigatório no caso de aceite | 20 |
reject_reason | string | Motivo da recusa de uma devolução (somente em analysis_result igual a rejected). "no_balance", "account_closure" ou "other" | 15 |