BSbs2
SolicitacaoDevolucao

Endpoint para receber Webhook de atualizações na solicitacao de devolução (MED)

Requisitos:

  • Endpoint que deve ser implementado pelo cliente para receber Webhook de atualizações na solicitacao de devolução (MED).
  • Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto
post/bs2/pix/indireto/webhook/mock/solicitacao-devolucao

Request

  • The document declares no server URL.
  • Auth
    none required

Headers

apikeystring required

api key

Request body

idstring uuid
razao'FRAUD' | 'OPERATIONAL_FLAW' | 'REFUND_CANCELLED' | 'PIX_AUTOMATICO'
valornumber double nullable

Valor solicitado para devolução.

comentariostring nullable

Breve descrição do motivo da solicitação de devolução.

status'OPEN' | 'CLOSED' | 'CANCELLED'
ispbSolicitantestring nullable

Identificador SPB do participante solicitante da devolução.

ispbContestadostring nullable

Identificador SPB do participante sendo contestado.

criadoEmstring date-time nullable

Data-hora da criação da requisição de devolução.

modificadoEmstring date-time nullable

Data-hora da última atualização de status.

idInfracaostring uuid nullable

Identificador da notificação de infração no caso de devolução por fraude.

resultadoAnalise'TOTALLY_ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED'
detalhesAnalisestring nullable

Detalhes da análise da requisição de devolução indicando a motivação do resultado.

razaoRejeicao'NO_BALANCE' | 'ACCOUNT_CLOSURE' | 'CANNOT_REFUND' | 'OTHER' | 'INVALID_REQUEST'
idTransacaostring nullable

Transação sendo contestada.

idTransacaoDevolucaostring nullable

Transação de devolução (completa ou parcial)

Example request

{
  "idInfracao": "5A2E41FD-AEB8-4B78-864A-40B7F7EE8AEB"
}

Response

Webhook recebido com sucesso.

statusCodeinteger

Changes

No recorded changes to this operation across all 1 revision of this API.