Remover Webhook

Remove uma configuração de webhook previamente estabelecida. Isso significa interromper o envio de mensagens de um determinado tipo para o parceiro, uma vez que não existirão configurações para definir como esses dados seriam enviados.

Request

A chamada deverá ser feita utilizando o método DELETE.

URL

{BaseUrl}/api/v1/webhooks

HTTP Headers - Exemplo:

Authorization: Basic {base64(client_id:client_secret)}
Content-Type: application/json

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
type (Opcional)	Tipo de webhook a remover. Caso não seja informado, todas as configurações da conta são removidas.	STRING pix_in ou pix_out

Exemplo cURL – bash (remover todos):

curl -X DELETE https://api.moneyguard.com.br/api/v1/webhooks \
    -H "Authorization: Bearer seu_access_token"

Exemplo cURL – bash (remover apenas um tipo):

curl -X DELETE "https://api.moneyguard.com.br/api/v1/webhooks?type=pix_in" \
    -H "Authorization: Bearer seu_access_token"

Response

Em caso de sucesso, será retornada uma mensagem HTTP 200 informando o êxito da operação.

HTTP 200 Response Body - Removendo um tipo específico

{
    "message": "Webhook pix_in successfully removed"
}

HTTP 200 Response Body - Removendo todas as configurações

{
    "message": "2 webhook(s) successfully removed"
}

Error

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 404 Response Body - Tipo informado sem configuração

{
    "error": "Webhook pix_in not found"
}

HTTP 400 Response Body - Nenhuma configuração cadastrada

{
    "error": "No configuration registered"
}