Configurar o Webhook Pix.

PUT

/webhook/{chave}

Webhook

Endpoint para configuração do serviço de notificações acerca de Pix recebidos.
Somente Pix associados a um txid serão notificados.

Exemplo do corpo do Webhook PIX

{
"txid": "971122d8f37211eaadc10242ac120002",
"valor": "110.00",
"horario": "2020-09-09T20:15:00.358Z",
"pagador": {
"cpf": "0123456789",
"nome": "Nome Pagador"
},
"endToEndId": "E12345678202009091221abcdef12345"
}

Callbacks

listaPix

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

webhook.write-Permissão para alteração do webhook

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Webhook para notificações acerca de Pix recebidos associados a um txid.

Bodyapplication/json

🟠400

🟠403AcessoNegado

🟠404NaoEncontrado

🔴503ServicoIndisponivel

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/webhook/' \
--header 'Content-Type: application/json' \
--data '{
    "webhookUrl": "https://pix.example.com/api/webhook/"
}'

Response Example

200 - Exemplo de retorno da requisição 1

{
    "webhookUrl": "https://pix.example.com/api/webhook/",
    "chave": "7d9f0335-8dcc-4054-9bf9-0dbd61d36906",
    "criacao": "2020-09-09T20:15:00.358Z"
}

Página anterior

Exibir informações acerca do Webhook Pix.

Próxima página