Skip to main content
Este evento é específico da loja no Discord. Quando um pedido feito pelo bot é pago, a gente avisa a URL configurada na conta.
Diferente do PIX e do cartão, aqui não existe callbackUrl por cobrança. Vale a URL da conta, configurada uma vez em Dashboard → Equipe & API → Developer API, para todos os pedidos do bot.

Campos

string
required
Sempre order.paid.
string
required
Identificador interno do pedido.
string
required
Código curto do pedido, o mesmo que aparece para o comprador no Discord.
number
required
Valor total em reais, decimal.
string
required
Data e hora da confirmação, em ISO 8601.
string
Identificador interno de qual processadora tratou o pagamento. Pode mudar sem aviso, então não construa lógica em cima dele.

Quem pagou

Os três campos abaixo são os mesmos de charge.paid e payment.paid, com o mesmo formato. Eles vêm do PIX e dependem do banco de origem: instituição que não informa o dado faz o campo ser omitido do corpo, nunca enviado vazio ou como null.
string
Nome de quem pagou, como consta no banco.
string
CPF ou CNPJ de quem pagou, só com os dígitos: 12345678909. Sem pontuação, para bater direto com o que você guarda do seu lado. Use para conciliar com o extrato bancário e para responder disputa.Alguns bancos de origem mandam o documento censurado. Nesse caso ele vai como veio, com os asteriscos na posição em que o banco os pôs (***456789**), e cpfMasked chega junto. Nunca chega um pedaço do número passando por número inteiro.
boolean
true quando o cpf veio censurado do banco de origem. Ausente quando o número chegou completo.
string
Banco de origem, no formato código - nome.
cpf é dado pessoal de quem pagou, e chega inteiro sempre que o banco de origem o informa por inteiro. Receba em HTTPS, guarde só o tempo que a sua operação precisa e não exponha em log de aplicação nem em tela de terceiro. A chave PIX, o telefone e o endereço do pagador não saem em webhook nenhum.

Para que serve

Sincronizar estoque

Baixar a quantidade no seu ERP ou planilha assim que a venda confirma, sem depender de consulta periódica.

Alimentar CRM

Registrar o cliente e a compra no seu funil no momento certo.

Contabilidade

Lançar a receita com data e valor exatos, em vez de exportar relatório no fim do mês.

Notificação interna

Avisar a equipe no canal certo quando entra venda acima de um valor.
Este evento avisa que o pedido foi pago. Ele não substitui o webhook de pagamento nas cobranças criadas pela API: são fluxos separados, com origens diferentes.
As garantias são as mesmas: assinatura HMAC, X-Webhook-Id para deduplicar, timeout de 5 segundos e reentrega com backoff.