Parcelamento Inteligente

Eventos

Parcelamento Inteligente Criado

Evento disparado quando um parcelamento inteligente é criado com sucesso para uma compra parcelada.

{
  "type": "smart_installment.created",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sourceInvoiceId": "e96a0f25-85b1-486b-ae0a-d7bc45922053",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "created",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2024-11-27T02:21:16.280Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 1
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

{
  "type": "smart_installment.created",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "created",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2024-11-27T02:21:16.280Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 1
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Parcelamento Inteligente Falhou

Evento disparado quando um parcelamento inteligente falhou ao tentar efetuar a primeira cobrança do parcelamento.

{
  "type": "smart_installment.aborted",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sourceInvoiceId": "e96a0f25-85b1-486b-ae0a-d7bc45922053",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "aborted",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "aborted",
          "when": "2024-11-27T02:21:19.960Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

{
  "type": "smart_installment.aborted",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "direct",
      "status": "aborted",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "aborted",
          "when": "2024-11-27T02:21:19.960Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Parcelamento Inteligente Em Andamento

Evento disparado quando um parcelamento inteligente entra em vigência, significando que não existe parcelas em atraso.

{
  "type": "smart_installment.on_schedule",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sourceInvoiceId": "e96a0f25-85b1-486b-ae0a-d7bc45922053",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "on_schedule",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

{
  "type": "smart_installment.off_schedule",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "direct",
      "status": "on_schedule",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Parcelamento Inteligente Em Atraso

Evento disparado quando um parcelamento inteligente muda o estado para Em Atraso, significando que uma parcela esta em atraso.

{
  "type": "smart_installment.off_schedule",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sourceInvoiceId": "e96a0f25-85b1-486b-ae0a-d7bc45922053",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 2,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "off_schedule",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        },
        {
          "status": "off_schedule",
          "when": "2025-05-27T15:21:24.129Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

{
  "type": "smart_installment.off_schedule",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "direct",
      "status": "off_schedule",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        },
        {
          "status": "off_schedule",
          "when": "2025-05-27T15:21:24.129Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Parcelamento Inteligente Cancelado

Evento disparado quando um parcelamento inteligente é cancelado com sucesso, devido uma fatura ter reembolso, contestação ou cancelamento intencional.

{
  "type": "smart_installment.canceled",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sourceInvoiceId": "e96a0f25-85b1-486b-ae0a-d7bc45922053",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "canceled",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        },
        {
          "status": "canceled",
          "when": "2025-05-27T15:21:24.129Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+551198864d6d782"
    }
  },
  "version": "2.0.0"
}

{
  "type": "smart_installment.canceled",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 1,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "canceled",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        },
        {
          "status": "canceled",
          "when": "2025-05-27T15:21:24.129Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-05-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+551198864d6d782"
    }
  },
  "version": "2.0.0"
}

Parcelamento Inteligente Concluído.

Evento disparado quando não existem mais nenhuma parcela pendente e todas estão pagas.

{
  "type": "smart_installment.completed",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sourceInvoiceId": "e96a0f25-85b1-486b-ae0a-d7bc45922053",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 12,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "recovery",
      "status": "completed",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        },
        {
          "status": "completed",
          "when": "2025-11-27T15:21:24.129Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-11-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+551198864d6d782"
    }
  },
  "version": "2.0.0"
}

{
  "type": "smart_installment.completed",
  "event": {
    "product": {
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0"
    },
    "products": [{
      "id": "inAVzweR0QYw5y03K5mq",
      "name": "Integrações com Webhook 2.0",
      "offers": [{
        "id": "inAVzweR0QYw5y03K5mq",
        "name": "Principal",
        "cohorts": [{ "id": "3a96c85e-cf82-4236-b242-7431f405c521" }]
      }]
    }],
    "smartInstallment": {
      "id": "747fe2c2-7ec6-44c7-bf01-789bbca4fde6",
      "subscriptionId": "9b677bd4-a57d-4394-8729-42d1aaee874e",
      "sellerId": "O4fgEI93QqYjs3IBdvUeS12JqbA3",
      "payerId": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "installment": 12,
      "installments": 12,
      "paymentMethod": "credit_card",
      "type": "direct",
      "status": "completed",
      "statusAt": [
        {
          "status": "created",
          "when": "2024-11-27T02:21:16.280Z"
        },
        {
          "status": "on_schedule",
          "when": "2024-11-27T02:21:19.960Z"
        },
        {
          "status": "completed",
          "when": "2025-11-27T15:21:24.129Z"
        }
      ],
      "amount": {
        "totalCents": 239172
      },
      "modifiedAt": "2025-11-27T15:21:24.129Z",
      "createdAt": "2024-11-27T02:21:16.280Z",
      "version": 4
    },
    "user": {
      "id": "Yf7Ahs5DOJRTLvFf84s4uOp7B7Q2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+551198864d6d782"
    }
  },
  "version": "2.0.0"
}

Propriedades

Os eventos de membro seguem um padrão de payload e propriedades, sendo elas:

type string

Tipo do evento de Webhook

Valores possíveis

Descrição

smart_installment.created

Parcelamento Inteligente Criado

smart_installment.aborted

Parcelamento Inteligente Falhou

smart_installment.on_schedule

Parcelamento Inteligente Em Andamento

smart_installment.off_schedule

Parcelamento Inteligente Em Atraso

smart_installment.canceled

Parcelamento Inteligente cancelado

smart_installment.completed

Parcelamento Inteligente concluído

version string

Versão do contrato do payload. Neste caso o valor esperado será sempre v2.0.0.

event.product object

Representa as informações do produto comprado

event.product.id string

Identificador único do produto

event.product.name string

Nome do produto no momento da compra

event.user object

Representa as informações de usuário cadastradas na plataforma

event.user.id string

Identificador único do comprador

event.user.firstName string

Primeiro nome do comprador

event.user.lastName string

Sobrenome nome do comprador

event.user.document string

Representa o documento de identificação do comprador, podendo ser do tipo CPF, CNPJ ou nulo

event.user.email string

Email do comprador

event.user.phone string

Telefone com DDI e DDD do comprador

AnteriorFatura PróximoSolicitação de Reembolso

Atualizado há 21 dias

Isto foi útil?