Link

WebHook

Caso seja sua preferência, é possível implementar um WebHook em um sistema externo para receber notificações sobre pagamentos Aprovado ou Rejeitado usando a chave e o token gerada pelo Sistema Bass Pago.

Quando ocorrer um pagamento, o sistema realizará uma requisição POST para o endereço fornecido no campo “URL do webHook”, transmitindo os seguintes parâmetros:

• referenceNumber: Um identificador exclusivo gerado pelo Sistema Bass Pago para cada pagamento.
• status: Status atual da Venda. (APPROVED, REJECTED)
• type: Tipo de Pagamento efetuado.
• token: Identificador exclusivo do Link de pagamento. Vários webhooks podem ser recebidos com o mesmo token, já que um link de pagamento pode ter várias vendas.

        {
	"referenceNumber": "PCH64YBCN5Z",
	"status": "APPROVED",
	"type": "PIX",
	"token": "ZPLKZF1GGUW3DA1V80MCZUYL69BTZ4QZIUWFSPXK0QVS59QX0O",
}

      

			  
1
2
3
4
5
6
		  

Os estados a serem enviados serão “APPROVED” (Aprovado) ou “REJECTED” (Rejeitado).

Os tipos (type) de envio compreendem:

• PIX
• BOLETO

O sistema efetuará uma requisição. Caso não seja obtido o código de resposta 200, serão feitas até 5 solicitações, com intervalo de 5 minutos entre cada uma.

# Verifique o status do pagamento

O que se indica é que, uma vez recebida a notificação via webhook da alteração do status de um Checkout, a API de conciliação seja consultada.

No menu APIs de Conciliação > Verificação do Status da Venda via API

# Verifique WebHooks pendentes e encaminhamento de WebHook

É possível verificar a quantidade de WebHooks não reportados. Isto é que, no momento do envio do WebHook, não foi recebida uma resposta correta (Código 200) do servidor do cliente

        {
    "token" : "ZPLKZF1GGUW3DA1V80MCZUYL69BTZ4QZIUWFSPXK0QVS59QX0O",
    "key" : "Z7di23yJXbhmPc9dAClSbhYplqk57vT9"
}

      

A resposta retorna o número de WebHooks em que uma resposta não foi recebida do servidor do cliente. Se a quantidade for 0, então não há pendências

        {
    "totalItems": 0
}

      

# Encaminhamento de WebHook

Caso o campo totalItems retorne maior que 0, é possível reenviar todos os webhooks pendentes.

        {
    "token" : "ZPLKZF1GGUW3DA1V80MCZUYL69BTZ4QZIUWFSPXK0QVS59QX0O",
    "key" : "Z7di23yJXbhmPc9dAClSbhYplqk57vT9"
}