Pedidos (Orders) e Assinaturas (Subscriptions)

Nesta página, você encontrará informações sobre os Webhooks de pedidos (orders) e assinaturas (subscriptions).


Os webhooks de Orders (pedidos) e Subscriptions (assinaturas) compartilham o mesmo formato de payload. A única diferença entre eles está no valor do campo domain e nos status possíveis para cada tipo.

Diferenças principais

Campo
ORDER
SUBSCRIPTION

domain

ORDER

SUBSCRIPTION

tipo de operação

Pedido único

Cobrança recorrente

status possíveis

SENT, ABANDONED, PAID, CANCELED, LATE, PARTIALLY_PAID, REFUND, CHARGEBACK, PRE_AUTHORIZED

PENDING, ACTIVE, DEFAULTER, INACTIVE

payload

Mesmo formato JSON

Mesmo formato JSON


Status válidos

Pedidos (ORDER)

  • SENT

  • PRE_AUTHORIZED

  • PARTIALLY_PAID

  • PAID

  • CANCELED

  • REFUND

  • LATE

  • CHARGEBACK

  • ABANDONED

🔸 Pedidos com status LATE há mais de 90 dias são automaticamente marcados como ABANDONED.

Assinaturas (SUBSCRIPTION)

  • PENDING

  • ACTIVE

  • DEFAULTER

  • INACTIVE


Estrutura do Payload (único)

A estrutura abaixo é idêntica para ambos os domínios (ORDER e SUBSCRIPTION).

{
  "uuid": "5503ad3a-d9c4-4072-a7cb-12cf2dd0eaa7",
  "dateTime": "2025-10-21T14:04:05.930643751",
  "status": "SENT",
  "domain": "ORDER",
  "uuidBuyer": "33236116-743a-4c1c-afc4-79b8d5dbb5b5",
  "documentBuyer": "518287216",
  "address": {
    "country": "AU",
    "state": "TAS",
    "city": "",
    "district": "",
    "street": "balers way sunset beach",
    "zipCode": "7330",
    "number": "17",
    "complement": ""
  },
  "emailBuyer": "[email protected]",
  "metadata": null,
  "cnpjSeller": "56210126000145",
  "idSeller": 4922,
  "authorizationCode": "496847",
  "authorizationNsu": "155224",
  "cards": [],
  "refunds": []
}

Exemplo de Refunds

Quando houver estorno, o campo refunds será preenchido conforme o exemplo abaixo:

"refunds": [
  {
    "date": "2025-04-04",
    "amount": 121.12,
    "status": "SUCCESS"
  }
]

Em caso de dúvidas, entre em contato com o nosso time através do suporte disponibilizado.

Last updated

Was this helpful?