Pedidos

Conteúdo da Requisição

Existem três padrões de conteúdo disponível no sistema. Envio de notificações para pedidos e assinaturas.

Veja abaixo exemplos do conteúdos enviados:

Pedidos

As notificações de pedidos tem a diferença principal no atributo status.

Payload de pedido

{
  "platform": "azpague",
  "token": "d7410981-84f7-11ec-abec-1ad7a840e6d6",
  "public_key": "03e847967a948033e44e753ea0bb27d9",
  "order_number": "11111",
  "status": "waiting_payment",
  "checkout_id": "QLhmtP",
  "origin": "checkout",
  "src": "<src>",
  "ref": "<ref>",
  "customer": {
    "email": "elias@exemplo.com",
    "fullname": "Elias Heitor Martins",
    "taxvat": "73845499222",
    "telephone": "6137210648"
  },
  "address": {
    "postcode": "73751-100",
    "street": "Rua Quadra 10",
    "number": "681",
    "complement": "",
    "city": "Planaltina",
    "region": "GO",
    "district": "Setor Norte"
  },
  "payment": {
    "method": "pix",
    "link_to_pay": "https://azpague.com.br/order/pay/60e723441bfc7/11111",
    "digitable": "",
    "due_date": ""
  },
  "totals": {
    "subtotal": 99,
    "fee": 0,
    "total": 99,
    "net": 99
  },
  "items": [
    {
      "sku": "123",
      "title": "Produto de Teste Webhook",
      "unit_price": 99,
      "quantity": 1
    }
  ],
  "created_at": "2021-07-08 13:09:42",
  "updated_at": "2021-07-08 13:09:42"
}

Eventos de Pedidos

Conheça os eventos que nosso sistema monitora para enviar webhooks nos pedidos.

Identificador	Evento	Descrição
abandoned	Carrinho Abandonado	Quando o cliente preencher o campo e-mail e/ou telefone.
waiting_payment	Aguardando Pagamento	No momento que o pedido é finalizado e a forma de pagamento selecionada é boleto bancário ou Pix.
paid	Paga	Quando o sistema confirma o pagamento de um pedido.
unpaid	Não paga	Quando o sistema não identifica pagamento de um pedido. Pode ser executada no momento que o pagamento de cartão de crédito, boleto bancário e Pix, quando não é reconhecido ou aprovado o pagamento.
refund	Estornada	Caso é realizado um estorno da transação.
chargeback	Chargeback	Quando o cliente solicitar uma disputa de uma transação.

Todos os atributos

Identificador	Tipo	Descrição
token	Texto	É o token único gerado no momento da criação do item, que pode ser utilizado para comunicação entre sistemas, identificando o objeto.
order_number	Texto	Um número sequencial gerado no momento de criação, visível no painel administrativo, que pode ser usado para facilitar comunicações de atendimento, validações de segurança e integridade das informações.
public_key	Inteiro	Sequência de segurança, visível no painel para validação de integridade da informacão.
status	Texto	Status do pedido.
checkout_id	Texto	Informação para identificação do checkout onde foi realizado a transação.
origin	Texto	Identificação da fonte de origem do pedido, podem ser CHECKOUT ou API.
src	Texto	Pode ser usado para referência externa, informada no momento do pedido para identificação o pedido. Essa informação é devolvida na consulta por API ou webhooks.
ref	Texto	Pode ser usado para referência externa, informada no momento do pedido para identificação o pedido. Essa informação é devolvida na consulta por API ou webhooks.
customer ⌄	Objeto	Dados do comprador
fullname	Texto	Nome do comprador. Ex: João da Silva
taxvat	Texto	Documento do comprador. Ex: 94919583052
email	Texto	Email do comprador.
telephone	Texto	Telefone do comprador. Ex: 51999999999
address ⌄	Objeto
postcode	Texto	CEP do endereço do comprador. Ex: 90670-090
street	Texto	Logradouro do endereço do comprador. Ex: Av. Princesa Isabel
number	Número	Número do endereço do comprador. Ex: 123
complement	Texto	Complemento do endereço do comprador. Ex: Sala 801
district	Texto	Bairro do endereço do comprador. Ex: Higienopolis
city	Texto	Cidade do endereço do comprador. Ex: Porto Alegre
region	Texto	UF do endereço do comprador. Ex: RS
items ⌄	Array	Lista de produtos adicionais ao checkout, caso não estejam cadastrado no sistema.
items[].title	Texto	Descrição do produto nessa transação. Ex: Camisa branca
items[].sku	Texto	Codigo do produto nessa transação. Se não informado, o nome do produto é usado para gerar um slug. Ex: camiseta-branca
items[].unit_price	Decimal	Valor unitário do produto nessa transação. Não utilize virgula para casa decimal de centavos. Ex: 25.00
items[].quantity	Inteiro	Quantidade do produto nessa transação. Ex: 2
payment ⌄	Objeto
method	Texto	Identificado da forma de pagamento utilizada.
link_to_pay	Url	Link para a versão web do nosso checkout para cliente pagar. Em caso de boleto e Pix, poderá encaminhar o cliente para facilitar o pagamento.
digitable	Texto	Número do boleto bancário ou código Pix/Cola do QRcode.
due_date	Data	Data que o pagamento irá expirar.
installments	Inteiro	Número de parcelas.
custom_total	Decimal	Se deseja enviar um valor customizado para o total da transação.
custom_quantity	Inteiro	Se deseja informar a quantidade de itens que represantam essa transação.