Comunicamos via webhook quando o pedido muda para os status AUTHORIZED, CANCELED e EXPIRED.

AUTHORIZED: O pedido está autorizado para ser criado o pagamento pelo varejista.

CANCELED: O pedido foi cancelado pelo consumidor.

EXPIRED: O pedido foi expirado.

Formato e requisição

O webhook será chamado via uma requição REST utilizando o método POST para a URL no campo webhook_url informada na criação do pedido, com o seguinte corpo:

{
  "id": "aae11abd-1f51-4854-b58b-473f83b2319f",
  "amount": 20000,
  "metadata": {
    "anyData": "XPTO"
  },
  "orderReference": "23423hshd3",
  "reference": "ASLKDFH28RY2E28938EHFEWJKF",
  "state": "AUTHORIZED",
  "type": "split"
}

Descrição dos campos

Nome do campo	Tipo	Descrição
id	string	ID do checkout gerado pela api Pagaleve /checkouts.
amount	number	Valor do pedido em centavos, passado na criação do checkout em `order.amount`
metadata	object	Objeto metadata fornecido no momento de criação do pedido
orderReference	string	ID do pedido utilizado pelo lojista, passado no campo `order.reference` na criação do checkout
reference	string	ID do pedido utilizado na plataforma que o lojista utiliza para vendas
state	enum	Status do pedido: AUTHORIZED - Autorizado, Cliente confirmou o pagamento da primeira parcela RELEASED - Liberado, retornado quando foi feito o release do pedido caso o pagamento tenha sido criado como do tipo autorização. CANCELED - Cancelado, para pedidos cancelados por ação do usuário. EXPIRED - Expirado, para pedidos expirados.
type	enum	Tipo de pagamento utilizado. split - Parcelado upfront - À vista declined - Declinado