Criar webhook para falhas em operações de saída.

Este webhook é acionado quando uma operação de saída é rejeitada na validação, antes ou durante o envio do Pix.

O campo data.message (repetido em transaction.message) identifica o motivo. O formato do POST enviado à sua URL está em Callback payload samples.

Mensagens de rejeição

Mensagem	O que significa
Chave não encontrada	A chave Pix informada não existe no DICT. O texto também pode vir como `Chave Pix não encontrada`.
Não foi possível consultar chave Pix	A consulta ao DICT falhou. Tente novamente mais tarde.
Chave associada a uma conta ou usuário com restrição	A chave existe, mas a conta ou o usuário recebedor está com restrição e não pode receber o Pix.
Chave Pix indisponível para consulta no momento	O DICT está temporariamente indisponível para essa chave. Tente novamente.
ISPB não autorizado	O ISPB do destinatário não é aceito para esta operação.
Transação não autorizada.	A transação foi recusada pelas regras de autorização da conta ou do arranjo.
Dados do destinatário não informados.	Faltam dados obrigatórios do recebedor (conta, documento ou nome).
Nome do destinatário não retornado pela consulta da chave Pix.	A consulta da chave não devolveu o nome do recebedor. Sem esse dado a transferência não segue.
Não é possível realizar transferências para contas de terceiros	A conta de origem só permite Pix para contas do mesmo titular.
Não é possível realizar transferências para a mesma conta	Origem e destino são a mesma conta.
Conta não autorizada para pagamentos através do Pix para Pessoa Física.	A conta autenticada não pode enviar Pix para CPF.
Conta não autorizada para pagamentos através do Pix para Pessoa Jurídica.	A conta autenticada não pode enviar Pix para CNPJ.
Limite de valores excedido para envio de Pix	O valor ultrapassa o limite configurado para envio de Pix nesta conta.
Pagamento expirado por timeout	A operação não foi concluída no tempo limite e foi rejeitada.
Saldo insuficiente para realizar transação.	Não há saldo disponível para o valor solicitado.
Não autorizado. Conta configurada para não permitir cash out.	A conta está configurada para bloquear saídas (cash out).

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-Permite cadastrar, alterar ou remover webhooks

Parâmetros Bodyapplication/jsonNecessário

Examples

curl --location '/webhooks/cashout' \ --header 'Content-Type: application/json' \ --data '{ "uri": "http://example.com", "email": "string", "method": "POST", "enabled": true, "pauseOnFail": true, "headers": { "headerName": "string" } }'

Criar webhook para falhas em operações de saída.

Callbacks

notification

Requisição

Respostas