Consultar Configuração de Webhook

Permite que o parceiro liste os endereços webhooks cadastrados.

Request

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

URL

{BaseUrl}/api/v1/webhooks

HTTP Headers - Exemplo:

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

Exemplo cURL – bash:

curl -X GET https://api.moneyguard.com.br/api/v1/webhooks \
    -H "Authorization: Bearer seu_access_token" \
    -H "User-Agent: seu_user_agent"

Response

HTTP 200 - Request Body - json - Um 'type'cadastrado

{
    "webhooks": [
        {
            "type": "pix_in",
            "callback_url": "https://webhook.site/61a36604-6fa5-485d-acd5-3fadcab714dd",
            "auth_header": "Teste Webhook",
            "events": [
                "collection.paid"
            ]
        }
    ]
}

HTTP 200 - Request Body - json - Todos 'type' cadastrados

{
    "webhooks": [
        {
            "type": "pix_in",
            "callback_url": "https://webhook.site/61a36604-6fa5-485d-acd5-3fadcab714dd",
            "auth_header": "Teste Webhook",
            "events": [
                "collection.paid"
            ]
        },
        {
            "type": "pix_out",
            "callback_url": "https://webhook.site/61a36604-6fa5-485d-acd5-3fadcab714dd",
            "auth_header": "Teste Webhook",
            "events": [
                "transfer.completed",
                "transfer.failed",
                "transfer.refunded"
            ]
        }
    ]
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
webhooks (Obrigatório)	Lista de objetos de webhooks cadastrados	LIST
webhooks.callback_url (Obrigatório)	Endereço destino da mensagem do webhook	STRING limite de 255 caracteres, iniciando com https://
webhooks.type (Opcional)	Tipo de transação que será enviada	STRING pix_in - para transações de pix-in(collection), pix_out - para transações de pix-out(transfer)
webhooks.authorization (Opcional)	Valor que será enviado no header Authorization para comprovar que é a Moneyguard que está enviando a mensagem	STRING limite de 100 caracteres
webhooks.events (Obrigatório)	Tipo do evento que será possível ser retornado	STRING limite de 100 caracteres

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 - Exemplo

{
  "error": "Configuration not found"
}