Exibir informações acerca do Webhook Pix.

GET

/webhook/{chave}

Webhook

Endpoint para recuperação de informações sobre o Webhook Pix.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://infopago.apidog.io//webhook/'

Response Example

200 - Exemplo de consulta de Webhook 1

{
    "webhookUrl": "https://pix.example.com/api/webhook/",
    "chave": "40a0932d-1918-4eee-845d-35a2da1690dc",
    "criacao": "2020-11-11T10:15:00.358Z"
}

Requisição

Parâmetros Path

chave

string

requerido

Respostas

🟢200OK

application/json

Dados do webhook.

Body

webhookUrl

string <uri>

requerido

Exemplo:

https://pix.example.com/api/webhook/

chave

string

Chave DICT do recebedor

requerido

Formato do campo chave

O campo chave determina a chave Pix registrada no DICT que será utilizada para a cobrança. Essa chave será lida pelo aplicativo do PSP do pagador para consulta ao DICT, que retornará a informação que identificará o recebedor da cobrança.

Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.

O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.

<= 77 Caracteres

criacao

string <date-time>

Data de Criação

read-onlyrequerido

Data e hora em que o webhook foi cadastrado. Respeita RFC 3339.

🟠403Forbidden

🟠404Record Not Found

🔴503Service Unavailable

Página anterior

Configurar o Webhook Pix.

Próxima página

Cancelar o webhook Pix.