Cancelada

Notifica quando o status da fatura muda para cancelada

Evento:
myeduzz.invoice_canceled
undefined

Response params

id
string

Id do evento

event
string

Nome do evento

data
object

Dados da fatura, produtor, comprador

data.id
string
data.status
string
data.buyer
object

Dados do comprador

data.buyer.id
string

Id do comprador

data.buyer.name
string

Nome do comprador

data.buyer.document
string

Documento do comprador

data.buyer.email
string

Email do comprador

data.buyer.phoneNullable
string

Telefone do comprador

data.buyer.phone2Nullable
string

Telefone do comprador

data.buyer.cellphoneNullable
string

Celular do comprador

data.buyer.address
object

Endereço do comprador

data.buyer.address.streetNullable
string

Nome da rua

data.buyer.address.numberNullable
string

Número do logradouro

data.buyer.address.neighborhoodNullable
string

Nome do bairro

data.buyer.address.complementNullable
string

Complemento do endereço

data.buyer.address.cityNullable
string

Nome da cidade

data.buyer.address.stateNullable
string

Estado de residência

data.buyer.address.countryNullable
string

País de residência

data.buyer.address.zipCodeNullable
string

Código postal

data.producer
object

Dados do produtor

data.producer.id
string

Id do produtor

data.producer.name
string

Nome do produtor

data.producer.email
string

Email do produtor

data.producer.originSecret
string

Token de segurança do webhook

data.utmNullable
object

Dados dos parâmetros utm recebidos no checkout por queryString

data.utm.sourceNullable
string

Fonte utm

data.utm.campaignNullable
string

Campanha utm

data.utm.mediumNullable
string

Meio utm

data.utm.contentNullable
string

Conteúdo utm

data.createdAt
string

Data de criação da fatura

data.dueDate
string

Data de vencimento da fatura

data.barcodeNullable
string

Código de barras em caso de boleto

data.price
object

Preço da fatura

data.price.currency
string

Moeda da fatura

data.price.value
number

Valor total da fatura

data.installments
number

Número de parcelas

data.items
object

Itens da fatura

data.items.productId
string

Id do produto

data.items.name
string

Nome do produto

data.items.parentIdNullable
string

Id do produto pai

data.items.refundPeriod
object

Periodo de reembolso

data.items.refundPeriod.durationType
string

Tipo de duração

data.items.refundPeriod.value
number

Tempo de duração

data.items.price
object

Preço do item

data.items.price.currency
string

Moeda que o item foi oferecido

data.items.price.value
number

Valor do item

data.items.price.couponNullable
object

Cupom aplicado

data.items.price.coupon.idNullable
string

Id do cupom

data.items.price.coupon.keyNullable
string

Chave do cupom

data.items.price.coupon.discount
object

Desconto do cupom

data.items.price.coupon.discount.currency
string

Moeda do desconto aplicado

data.items.price.coupon.discount.value
number

Valor do desconto aplicado

data.items.partnerIdNullable
string

Id do parceiro

data.items.billingType
enum

Tipo de cobrança

recurrence
single
free
other
unknown
data.items.skuReferenceNullable
string

Referência externa

data.totalItems
number

Total de itens da fatura

data.billetUrlNullable
string

Página com a chave gerada para o produto

data.checkoutUrl
string

URL do Checkout

data.bankslipUrlNullable
string

Url para acesso ao boleto caso seja um pagamento via boleto

data.postbackNullable
string

Url de postback configurada

sentDate
string

Data do envio do evento

Swagger Logo

Payload

1{
2  "id": "zszf0uk65g701io8dbsckfeld",
3  "event": "myeduzz.invoice_canceled",
4  "data": {
5    "id": "12345678",
6    "status": "canceled",
7    "buyer": {
8      "id": "66677677767",
9      "name": "Alice Johnson",
10      "document": "12333333",
11      "email": "alice.johnson@example.com",
12      "phone": "555-789-1234",
13      "phone2": "555-987-6543",
14      "cellphone": "555-321-9876",
15      "address": {
16        "street": "Rua avenida",
17        "number": "123",
18        "neighborhood": "Bairro",
19        "complement": "Complemento",
20        "city": "Cidade",
21        "state": "Estado",
22        "country": "Brasil",
23        "zipCode": "12345-123"
24      }
25    },
26    "producer": {
27      "id": "1454585458",
28      "name": "Orbita",
29      "email": "orbita@eduzz.com",
30      "originSecret": "originsecrettest"
31    },
32    "utm": {
33      "source": "source",
34      "campaign": "campaign",
35      "medium": "medium",
36      "content": "content"
37    },
38    "createdAt": "2024-01-09T14:45:00.000Z",
39    "dueDate": "2024-01-13T17:45:00.000Z",
40    "barcode": "88846758782537262653776655566",
41    "price": {
42      "currency": "BRL",
43      "value": 301.5
44    },
45    "installments": 1,
46    "items": [
47      {
48        "productId": "P567",
49        "name": "Widget X",
50        "parentId": "11111111",
51        "refundPeriod": {
52          "durationType": "days",
53          "value": 7
54        },
55        "price": {
56          "currency": "BRL",
57          "value": 150.75,
58          "coupon": {
59            "id": "123444",
60            "key": "cupomeduzz",
61            "discount": {
62              "currency": "BRL",
63              "value": 2
64            }
65          }
66        },
67        "partnerId": "12312321312321",
68        "billingType": "Única",
69        "skuReference": "skuReference"
70      },
71      {
72        "productId": "P789",
73        "name": "Gadget Y",
74        "parentId": "1111221",
75        "refundPeriod": {
76          "durationType": "days",
77          "value": 7
78        },
79        "price": {
80          "currency": "BRL",
81          "value": 150.75,
82          "coupon": {
83            "id": "123444",
84            "key": "cupomeduzz",
85            "discount": {
86              "currency": "BRL",
87              "value": 1
88            }
89          }
90        },
91        "partnerId": "12312321312321",
92        "billingType": "single",
93        "skuReference": "skuReference"
94      }
95    ],
96    "totalItems": 2,
97    "billetUrl": "https://urlbillet.com.br",
98    "checkoutUrl": "https://urlcheckout.com.br",
99    "bankslipUrl": "https://urlbankslip.com.br",
100    "postback": "https://urlpostback.com.br"
101  },
102  "sentDate": "2024-01-20T15:00:00.000Z"
103}