Configurar Webhook

Configure o webhook para receber notificacoes em tempo real quando um pagamento Pix for recebido.

Apenas pagamentos Pix que possuem txid (gerados via cobranca) acionam o webhook. Pix recebidos sem txid nao geram notificacao. Os IPs de origem das notificacoes sao dinamicos e podem mudar sem aviso previo.

PUT/webhook/{chave_pix}

Configura a URL de webhook que recebera notificacoes de pagamentos Pix para a chave informada.

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Content-Type`	application/json	Tipo do conteudo da requisicao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`chave_pix`	string	Chave Pix para a qual o webhook sera configurado

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`uri`	string	Obrigatorio	URL do webhook que recebera as notificacoes (deve ser HTTPS)
`enabled`	boolean	Obrigatorio	Define se o webhook esta ativo (true) ou inativo (false)
`headers`	object	Opcional	Headers customizados enviados junto com a notificacao do webhook

Exemplo de Request

{
  "uri": "https://sua-api.com.br/webhook/pix",
  "enabled": true,
  "headers": {
    "X-Custom-Auth": "meu-token-secreto"
  }
}

Exemplo de Response

{
  "webhookUrl": "https://sua-api.com.br/webhook/pix",
  "chave": "sua-chave-pix@example.com",
  "criacao": "2025-01-15T10:30:00.000Z"
}

Exemplos de Codigo

curl -X PUT https://api.pix.basspago.com.br/webhook/sua-chave-pix@example.com \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "uri": "https://sua-api.com.br/webhook/pix",
    "enabled": true,
    "headers": {
      "X-Custom-Auth": "meu-token-secreto"
    }
  }'