Recorrência

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 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": "PCH64YBCN5Z",
	"status": "APPROVED",
	"type": "CARD",
        "planReferenceNumber" : "PLJD0LFM80",
        "subscriptionReferenceNumber" : "SBBAFVJ0A9",
        "installment" : "1"

}

      

			  
1
2
3
4
5
6
7
8
9
		  

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

Os tipos (type) de envio compreendem:

• CARD

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 do Cobrança via API

# Verifique WebHooks pendentes

É 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

        {
	"key": "UydmVYUIYdfKmeED1JgdRMvXkeyri7iu"
}

      

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.

        {
	"key": "UydmVYUIYdfKmeED1JgdRMvXkeyri7iu"
}