Webhooks

Configuração de Webhook

O QR Code dinâmico para pagamento imediato é projetado para facilitar transações de valores específicos em um momento próximo à sua criação. Ele contém informações detalhadas sobre o recebedor da transação e permite a inclusão de dados sobre o pagador, facilitando a identificação posterior de quem efetuou o pagamento.

Adicionalmente, esse tipo de QR Code oferece a flexibilidade para o emissor definir um valor fixo para a transação ou permitir que o pagador ajuste a quantia a ser paga no momento da operação.

Funcionamento do authorization

Na configuração do webhook, você pode definir o campo authorizationSchema, que especifica o tipo de autorização a ser utilizada para autenticar as requisições enviadas.

Os valores possíveis para authorizationSchema são:

• BASIC: A autorização será enviada no header Authorization no formato Basic $value, onde $Value é o valor configurado no campo authorization.

• BEARER: A autorização será enviada no header Authorization no formato Bearer $value, onde $value é o valor configurado no campo authorization.

• HEADER: A autorização será enviada no header onde o valor do header será $key e o valor do header será $value. As informações deste tipo de configuração, deve ser enviada no campo authorization, e deve estar no formato key:value.

Tipos de eventos

Nome	Descrição
CHARGE_PAID	Ocorre quando uma cobrança (QRCode) é paga
PIX_PAYMENT_UPDATED	Ocorre quando uma ordem de pagamento cashout pix tem seu status atualizado para PIX_EFFECTIVE ou PIX_ERROR. Este evento é disparado após a criação de uma ordem de pagamento
PIX_REFUND_PAYMENT_UPDATED	Ocorre quando uma ordem de devolução cashout refund pix tem seu status atualizado para PIX_EFFECTIVE ou PIX_ERROR. Este evento é disparado após a criação de uma ordem de devolução
PIX_REFUNDED	Ocorre quando a conta recebe um crédito de um Pix Devolvido

Requisição

POST /baas/api/v1/webhooks

Parâmetros da requisição | Request Body Schema

Nome	Tipo	Tamanho	Obrg	Descrição
eventType	Enum	-	Sim	Utilizar os tipos de eventos citados acima
url	String	100	Sim	URL que será utilizada pelos sistemas ONE para notificar o cliente
authorizationScheme	Enum	-	Não	Esquema de autenticação que deve ser utilizado durante a chamada HTTP para a URL citada. Tipos de esquemas disponíveis: BASIC, BEARER ou HEADER
authorization	String	-	Não	Valor que será utilizado no campo de authorization durante a chamada HTTP para a URL citada

Exemplo de requisição

{
  "eventType": "PIX_RECEIVED",
  "url": "https://receive-pix.webhook.com",
  "authorization": "Or6UsVzSYTcXpgdfKU9mMqrfO=",
  "authorizationScheme": "BASIC"
}

{
  "eventType": "PIX_RECEIVED",
  "url": "https://receive-pix.webhook.com",
  "authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30",
  "authorizationScheme": "BEARER"
}

{
  "eventType": "PIX_RECEIVED",
  "url": "https://receive-pix.webhook.com",
  "authorization": "api-key:0xKqefqyZJ5oXXqUxJ9v9vmyLSPqZHeN223S5VNSXdPPQfB8pJobAL3QgkOqe31k",
  "authorizationScheme": "HEADER"
}

Retorno da requisição | Response Schema

O statusCode HTTP 200 indicará que a cobrança foi cancelada.