Lista de eventName disponiveis para cadastro

É possivel obter a lista dos eventName através do endpoint abaixo

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.
O usuário esteja autenticado utilizando a Autenticação Gestão do Banco.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/WebhookInternal/descriptionsEventNameWebhook

--request POST 'https://sandbox.hiperbanco.com.br/WebhookInternal/descriptionsEventNameWebhook' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Código	Descrição
`ACCOUNT_WAS_CLOSED`	Conta foi encerrada
`ACCOUNT_WAS_CREATED`	Conta foi criada
`BILL_PAYMENT_HAS_FAILED`	Pagamento de conta falhou
`BILL_PAYMENT_WAS_CANCELLED`	Pagamento de conta foi cancelado
`BILL_PAYMENT_WAS_CONFIRMED`	Pagamento de conta foi confirmado
`BILL_PAYMENT_WAS_CREATED`	Pagamento de conta foi criado
`BILL_PAYMENT_WAS_RECEIVED`	Pagamento de conta foi recebido
`BILL_PAYMENT_WAS_REFUSED`	Pagamento de conta foi recusado
`BOLETO_CASH_IN_WAS_CLEARED`	Pagamento de boleto foi compensado
`BOLETO_CASH_IN_WAS_RECEIVED`	Pagamento de boleto foi recebido
`BOLETO_WAS_CANCELLED`	Boleto foi cancelado
`BOLETO_WAS_REGISTERED`	Boleto foi registrado
`BUSINESS_WAS_APPROVED`	Empresa foi aprovada
`BUSINESS_WAS_CANCELED`	Cadastro de empresa foi cancelado
`BUSINESS_WAS_RECEIVED`	Cadastro de empresa foi recebido
`BUSINESS_WAS_REPROVED`	Empresa foi reprovada
`CANCELATION_WAS_PROCESSED`	Cancelamento foi processado
`CARD_STATUS_WAS_MODIFIED`	Status do cartão foi modificado
`CARD_WAS_ISSUED`	Cartão foi emitido
`CUSTOMER_WAS_APPROVED`	Cliente foi aprovado
`CUSTOMER_WAS_BLOCKED`	Cliente foi bloqueado
`CUSTOMER_WAS_CANCELED`	Cadastro de cliente foi cancelado
`CUSTOMER_WAS_RECEIVED`	Cadastro de cliente foi recebido
`CUSTOMER_WAS_REPROVED`	Cliente foi reprovado
`CUSTOMER_WAS_REVOKED`	Cliente foi revogado
`CUSTOMER_WAS_UPDATED`	Cadastro de cliente foi atualizado
`DOCUMENT_WAS_PROCESSED`	Documento foi processado
`DOCUMENT_WAS_RECEIVED`	Documento foi recebido
`OPENFINANCE_AUTOMATIC_PIX_WAS_CONFIRMED`	Pix automático Open Finance foi confirmado
`OPENFINANCE_AUTOMATIC_PIX_WAS_FAILED`	Pix automático Open Finance falhou
`PIX_CASH_IN_WAS_CLEARED`	Pix recebido foi compensado
`PIX_CASH_IN_WAS_RECEIVED`	Pix recebido foi registrado
`PIX_CASHOUT_WAS_CANCELED`	Pix enviado foi cancelado
`PIX_CASHOUT_WAS_COMPLETED`	Pix enviado foi concluído
`PIX_CASHOUT_WAS_UNDONE`	Pix enviado foi desfeito
`PIX_REFUND_WAS_CLEARED`	Devolução Pix foi compensada
`PIX_REFUND_WAS_RECEIVED`	Devolução Pix foi recebida
`SLC_CASH_IN_WAS_CLEARED`	SLC recebido foi compensado
`SLC_CASH_IN_WAS_RECEIVED`	SLC recebido foi registrado
`TED_CASH_IN_WAS_CLEARED`	TED recebida foi compensada
`TED_CASH_OUT_WAS_APPROVED`	TED enviada foi aprovada
`TED_CASH_OUT_WAS_CANCELED`	TED enviada foi cancelada
`TED_CASH_OUT_WAS_DONE`	TED enviada foi concluída
`TED_CASH_OUT_WAS_UNDONE`	TED enviada foi desfeita
`TED_REFUND_WAS_CLEARED`	Devolução TED foi compensada
`TED_REFUND_WAS_RECEIVED`	Devolução TED foi recebida
`TRANSACTION_WAS_PROCESSED`	Transação foi processada
`TRANSACTION_WAS_REVERTED`	Transação foi revertida

[
    {
        "code": "ACCOUNT_WAS_CREATED",
        "name": "Conta foi criada"
    },
    {
        "code": "ACCOUNT_WAS_CLOSED",
        "name": "Conta foi encerrada"
    },
    {
        "code": "TRANSACTION_WAS_REVERTED",
        "name": "Transação foi revertida"
    },
    {
        "code": "CANCELATION_WAS_PROCESSED",
        "name": "Cancelamento foi processado"
    },
    {
        "code": "TRANSACTION_WAS_PROCESSED",
        "name": "Transação foi processada"
    },
    {
        "code": "BOLETO_CASH_IN_WAS_CLEARED",
        "name": "Pagamento de boleto foi compensado"
    },
    {
        "code": "BOLETO_WAS_REGISTERED",
        "name": "Boleto foi registrado"
    },
    {
        "code": "BOLETO_WAS_CANCELLED",
        "name": "Boleto foi cancelado"
    },
    {
        "code": "BOLETO_CASH_IN_WAS_RECEIVED",
        "name": "Pagamento de boleto foi recebido"
    },
    {
        "code": "BUSINESS_WAS_REPROVED",
        "name": "Empresa foi reprovada"
    },
    {
        "code": "BUSINESS_WAS_APPROVED",
        "name": "Empresa foi aprovada"
    },
    {
        "code": "BUSINESS_WAS_RECEIVED",
        "name": "Cadastro de empresa foi recebido"
    },
    {
        "code": "BUSINESS_WAS_CANCELED",
        "name": "Cadastro de empresa foi cancelado"
    },
    {
        "code": "CARD_WAS_ISSUED",
        "name": "Cartão foi emitido"
    },
    {
        "code": "CARD_STATUS_WAS_MODIFIED",
        "name": "Status do cartão foi modificado"
    },
    {
        "code": "CUSTOMER_WAS_REPROVED",
        "name": "Cliente foi reprovado"
    },
    {
        "code": "CUSTOMER_WAS_APPROVED",
        "name": "Cliente foi aprovado"
    },
    {
        "code": "CUSTOMER_WAS_RECEIVED",
        "name": "Cadastro de cliente foi recebido"
    },
    {
        "code": "CUSTOMER_WAS_CANCELED",
        "name": "Cadastro de cliente foi cancelado"
    },
    {
        "code": "CUSTOMER_WAS_UPDATED",
        "name": "Cadastro de cliente foi atualizado"
    },
    {
        "code": "CUSTOMER_WAS_REVOKED",
        "name": "Cliente foi revogado"
    },
    {
        "code": "CUSTOMER_WAS_BLOCKED",
        "name": "Cliente foi bloqueado"
    },
    {
        "code": "DOCUMENT_WAS_PROCESSED",
        "name": "Documento foi processado"
    },
    {
        "code": "DOCUMENT_WAS_RECEIVED",
        "name": "Documento foi recebido"
    },
    {
        "code": "OPENFINANCE_AUTOMATIC_PIX_WAS_CONFIRMED",
        "name": "Pix automático Open Finance foi confirmado"
    },
    {
        "code": "OPENFINANCE_AUTOMATIC_PIX_WAS_FAILED",
        "name": "Pix automático Open Finance falhou"
    },
    {
        "code": "BILL_PAYMENT_WAS_RECEIVED",
        "name": "Pagamento de conta foi recebido"
    },
    {
        "code": "BILL_PAYMENT_WAS_CREATED",
        "name": "Pagamento de conta foi criado"
    },
    {
        "code": "BILL_PAYMENT_WAS_CONFIRMED",
        "name": "Pagamento de conta foi confirmado"
    },
    {
        "code": "BILL_PAYMENT_HAS_FAILED",
        "name": "Pagamento de conta falhou"
    },
    {
        "code": "BILL_PAYMENT_WAS_CANCELLED",
        "name": "Pagamento de conta foi cancelado"
    },
    {
        "code": "BILL_PAYMENT_WAS_REFUSED",
        "name": "Pagamento de conta foi recusado"
    },
    {
        "code": "PIX_CASH_IN_WAS_RECEIVED",
        "name": "Pix recebido foi registrado"
    },
    {
        "code": "PIX_CASH_IN_WAS_CLEARED",
        "name": "Pix recebido foi compensado"
    },
    {
        "code": "PIX_CASHOUT_WAS_UNDONE",
        "name": "Pix enviado foi desfeito"
    },
    {
        "code": "PIX_CASHOUT_WAS_COMPLETED",
        "name": "Pix enviado foi concluído"
    },
    {
        "code": "PIX_CASHOUT_WAS_CANCELED",
        "name": "Pix enviado foi cancelado"
    },
    {
        "code": "PIX_REFUND_WAS_RECEIVED",
        "name": "Devolução Pix foi recebida"
    },
    {
        "code": "PIX_REFUND_WAS_CLEARED",
        "name": "Devolução Pix foi compensada"
    },
    {
        "code": "SLC_CASH_IN_WAS_RECEIVED",
        "name": "SLC recebido foi registrado"
    },
    {
        "code": "SLC_CASH_IN_WAS_CLEARED",
        "name": "SLC recebido foi compensado"
    },
    {
        "code": "TED_CASH_OUT_WAS_CANCELED",
        "name": "TED enviada foi cancelada"
    },
    {
        "code": "TED_CASH_OUT_WAS_DONE",
        "name": "TED enviada foi concluída"
    },
    {
        "code": "TED_CASH_IN_WAS_CLEARED",
        "name": "TED recebida foi compensada"
    },
    {
        "code": "TED_CASH_OUT_WAS_UNDONE",
        "name": "TED enviada foi desfeita"
    },
    {
        "code": "TED_CASH_OUT_WAS_APPROVED",
        "name": "TED enviada foi aprovada"
    },
    {
        "code": "TED_REFUND_WAS_RECEIVED",
        "name": "Devolução TED foi recebida"
    },
    {
        "code": "TED_REFUND_WAS_CLEARED",
        "name": "Devolução TED foi compensada"
    }
]

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.