#Introdução

Hooks podem ser configurados de acordo com os tipos de eventos desejados. Novos eventos podem ser adicionados conforme a necessidade.

Em casos de falha por problemas de comunicação, autenticação ou indisponibilidade, as notificações serão reenviadas a cada 5 minutos por um período de 2 horas. Após este período o reenvio será a cada 5 horas por um período de 3 dias.

Se após estas tentativas a notificação não tiver sucesso na entrega, será necessário a consulta do status da transação conforme a documentação.

#Tipos de eventos

CREATION: Evento emitido quando o reembolso for criado no gateway (Salvo na base gsurf).

CONFIRMATION: Evento emitido quando o reembolso é confirmado no provedor.

CONFIRMATION_ERROR: Evento emitido quando houver erro na confirmação da transação no provedor.

REFUND_REQUEST: Evento emitido quando uma requisição para confirmar reembolso for recebida.

EXPIRATION: Evento emitido quando uma transação for expirada, impossibilitando sua confirmação.

REQUEST_VALIDATION_ERROR: Evento emitido quando houver erro na validação do reembolso.

Obs: O payload do hook é versionado. As versões indicam os campos que são contidos no payload.

#Payload

#V1.0

versionstringconst: "1.0"

event_typestring

Enum: "CREATION", "CONFIRMATION", "EXPIRATION", "REFUND_REQUEST", "CONFIRMATION_ERROR", "REQUEST_VALIDATION_ERROR"

entitystringconst: "PixRefund"

payloadobject

refund_dataobject

Dados referentes ao reembolso.

gtistring

Identificador único da transação Pix.

amountinteger

Valor do reembolso.

refund_typestring

Tipo do reembolso.

Enum: "TOTAL", "PARTIAL"

creation_timestring

Data de criação do reembolso.

statusstring

Enum: "NEW", "EXPIRED", "CONFIRMED", "IN_PROGRESS", "ERROR", "DENIED"

confirmation_timestring | null

Data da confirmação do reembolso no gateway.

order_idstring | null

Número do pedido associado ao reembolso.

merchant_correlation_idstring | null

Identificador do reembolso na loja.

confirmation_idstring

Identificador do reembolso gerado pelo provedor.

original_paymentobject

sale_dataobject

Dados referentes ao pagamento original.

amountinteger

Valor do pagamento original.

merchant_correlation_idstring

Identificador do pagamento original na loja.

order_idstring

Número do pedido.

installmentsinteger

Número de parcelas.

submerchant_idstring

Identificador da loja.

payment_dataobject

Dados do pagamento original.

gtistring

Identificador único do pagamento original.

statusstring

Enum: "NEW", "EXPIRED", "AUTHORIZATION_IN_PROGRESS", "AUTHORIZED", "AUTHORIZATION_ERROR", "CONFIRMATION_IN_PROGRESS", "CONFIRMED", "CONFIRMATION_ERROR", "UNDOING_IN_PROGRESS", "UNDONE", "UNDOING_ERROR", "DENIED", "REVERSED"

amount_paidinteger

Valor pago na transação original.

channelstring

Canal

creation_timestring

Data de criação do pagamento original.

update_timestring

Data da última atualização do pagamento original.

effective_timestring | null

Data do pagamento original no provedor.

confirm_timestring | null

Data da confirmação do pagamento original no gateway.

subacquirer_documentstring

Documento do subadquirente

error_infoobject

Atributo recebido somente em eventos Emitidos para erro.

codestring

Código do erro.

messagestring

Mensagem descritiva do erro.

#Exemplo

{
  "version": "1.0",
  "entity": "PixRefund",
  "event_type": "CONFIRMATION",
  "payload": {
    "refund_data": {
      "gti": "857f9d11-35bc-4cbb-89f4-80421c839e68",
      "amount": 100,
      "refund_type": "TOTAL",
      "creation_time": "2024-08-30T15:24:37",
      "confirmation_time": "2024-08-30T18:24:37",
      "status": "CONFIRMED",
      "order_id": "3690272536",
      "confirmation_id": "fec018a9-2e05-43e7-86b6-e293fef4ed09",
      "merchant_correlation_id": "026b0627-83dc-42a0-bacc-a06f0da1227f"
    },
    "original_payment": {
      "sale_data": {
        "amount": 100,
        "merchant_correlation_id": "061918e5-500c-47fc-a108-fb6daeb36df3",
        "order_id": "12345678",
        "installments": 1,
        "submerchant_id": "05643319000159"
      },
      "payment_data": {
        "gti": "132b95b1-c6bb-40d5-8d51-c1fa2b246420",
        "status": "REVERSED",
        "amount_paid": 100,
        "channel": "ECOMMERCE",
        "creation_time": "2024-08-30T18:24:37",
        "update_time": "2024-08-30T18:24:37",
        "effective_time": "2024-08-30T18:24:37",
        "confirm_time": "2024-08-30T18:24:37",
        "subacquirer_document": "05643319000159"
      }
    }
  }
}

Hooks de Reembolso de Pix

#Introdução

#Tipos de eventos

#Payload

#V1.0

#Exemplo