Solicitação de Reembolso

Eventos


Solicitação de Reembolso criada

Evento disparado quando uma solicitação de reembolso é criada.

{
  "type": "refund_request.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" }]
      }]
    }],
    "invoice": {
      "id": "7614b1bb-1d1a-43ba-890c-50d74216eb56",
      "subscriptionId": "d7ab5027-5bca-476c-ac29-68f1359ee6ca",
      "payerId": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "sellerId": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
      "installments": 12,
      "paymentMethod": "credit_card",
      "currency": "BRL",
      "type": "sell",
      "status": "paid",
      "statusAt": [
        {
          "status": "unpaid",
          "when": "2024-03-28T20:35:22.671Z"
        },
        {
          "status": "paid",
          "when": "2024-03-28T20:35:33.512Z"
        }
      ],
      "amount": {
        "subtotalCents": 120000,
        "discountCents": 24000,
        "prorataCents": 0,
        "installmentFeeCents": 16320,
        "totalCents": 112320
      },
      "receivers": [
        {
          "id": "platform-identity",
          "name": "Hubla Tecnologia LTDA",
          "email": "suporte@hub.la",
          "phone": "+5531999715693",
          "role": "platform",
          "paysForFees": false,
          "totalCents": 25778
        },
        {
          "id": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
          "name": "Victor Lott",
          "email": "lott@hub.la",
          "phone": "+5533988891169",
          "role": "seller",
          "paysForFees": true,
          "totalCents": 86542
        }
      ],
      "firstPaymentSession": {
        "ip": "220.172.165.140",
        "utm": {
          "source": "email",
          "medium": "active-campaign",
          "campaign": "[LEAD][QUENTE][24][MAR]",
          "content": "2024032812H",
          "term": "PROMO10OFF"
        }
      },
      "billingAddress": {
        "countryCode": "BR",
        "state": "São Paulo",
        "city": "São Paulo",
        "neighborhood": "Bela Vista",
        "street": "Av. Paulista",
        "complement": "MASP",
        "number": "1578",
        "postalCode": "01310-200"
      },
      "saleDate": "2024-03-28T20:35:22.671Z",
      "dueDate": "2024-03-28T20:35:16.350Z",
      "createdAt": "2024-03-28T20:35:22.671Z",
      "modifiedAt": "2024-03-28T20:35:33.512Z",
      "version": 8
    },
    "refund": {
      "id": "lSEqN7PtlTk1lt4OIQ7j",
      "description": "Produto não respondeu com as expectativas.",
      "status": "created",
      "isAutoAccepted": true,
      "createdAt": "2024-03-30T12:42:12.512Z",
      "updatedAt": "2024-03-30T12:42:12.512Z"
    }
    "user": {
      "id": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Solicitação de Reembolso aceita

Evento disparado quando uma solicitação de reembolso é aceita, podendo ser automaticamente ou manual pelo vendedor.

{
  "type": "refund_request.accepted",
  "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" }]
      }]
    }],
    "invoice": {
      "id": "7614b1bb-1d1a-43ba-890c-50d74216eb56",
      "subscriptionId": "d7ab5027-5bca-476c-ac29-68f1359ee6ca",
      "payerId": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "sellerId": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
      "installments": 12,
      "paymentMethod": "credit_card",
      "currency": "BRL",
      "type": "sell",
      "status": "refunded",
      "statusAt": [
        {
          "status": "unpaid",
          "when": "2024-03-28T20:35:22.671Z"
        },
        {
          "status": "paid",
          "when": "2024-03-28T20:35:33.512Z"
        },
        {
          "status": "refunded",
          "when": "2024-03-28T21:47:53.177Z"
        }
      ],
      "amount": {
        "subtotalCents": 120000,
        "discountCents": 24000,
        "prorataCents": 0,
        "installmentFeeCents": 16320,
        "totalCents": 112320
      },
      "receivers": [
        {
          "id": "platform-identity",
          "name": "Hubla Tecnologia LTDA",
          "email": "suporte@hub.la",
          "phone": "+5531999715693",
          "role": "platform",
          "paysForFees": false,
          "totalCents": 25778
        },
        {
          "id": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
          "name": "Victor Lott",
          "email": "lott@hub.la",
          "phone": "+5533988891169",
          "role": "seller",
          "paysForFees": true,
          "totalCents": 86542
        }
      ],
      "firstPaymentSession": {
        "ip": "220.172.165.140",
        "utm": {
          "source": "email",
          "medium": "active-campaign",
          "campaign": "[LEAD][QUENTE][24][MAR]",
          "content": "2024032812H",
          "term": "PROMO10OFF"
        }
      },
      "billingAddress": {
        "countryCode": "BR",
        "state": "São Paulo",
        "city": "São Paulo",
        "neighborhood": "Bela Vista",
        "street": "Av. Paulista",
        "complement": "MASP",
        "number": "1578",
        "postalCode": "01310-200"
      },
      "saleDate": "2024-03-28T20:35:22.671Z",
      "dueDate": "2024-03-28T20:35:16.350Z",
      "createdAt": "2024-03-28T20:35:22.671Z",
      "modifiedAt": "2024-03-28T21:47:53.177Z",
      "version": 9
    },
    "refund": {
      "id": "lSEqN7PtlTk1lt4OIQ7j",
      "description": "Produto não respondeu com as expectativas.",
      "status": "pending",
      "isAutoAccepted": true,
      "createdAt": "2024-03-30T12:42:12.512Z",
      "updatedAt": "2024-03-30T12:42:12.512Z"
    },
    "user": {
      "id": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Solicitação de Reembolso cancelada

Evento disparado quando uma solicitação de reembolso é cancelada pelo comprador.

{
  "type": "refund_request.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" }]
      }]
    }],
    "invoice": {
      "id": "7614b1bb-1d1a-43ba-890c-50d74216eb56",
      "subscriptionId": "d7ab5027-5bca-476c-ac29-68f1359ee6ca",
      "payerId": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "sellerId": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
      "installments": 12,
      "paymentMethod": "credit_card",
      "currency": "BRL",
      "type": "sell",
      "status": "paid",
      "statusAt": [
        {
          "status": "unpaid",
          "when": "2024-03-28T20:35:22.671Z"
        },
        {
          "status": "paid",
          "when": "2024-03-28T20:35:33.512Z"
        }
      ],
      "amount": {
        "subtotalCents": 120000,
        "discountCents": 24000,
        "prorataCents": 0,
        "installmentFeeCents": 16320,
        "totalCents": 112320
      },
      "receivers": [
        {
          "id": "platform-identity",
          "name": "Hubla Tecnologia LTDA",
          "email": "suporte@hub.la",
          "phone": "+5531999715693",
          "role": "platform",
          "paysForFees": false,
          "totalCents": 25778
        },
        {
          "id": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
          "name": "Victor Lott",
          "email": "lott@hub.la",
          "phone": "+5533988891169",
          "role": "seller",
          "paysForFees": true,
          "totalCents": 86542
        }
      ],
      "firstPaymentSession": {
        "ip": "220.172.165.140",
        "utm": {
          "source": "email",
          "medium": "active-campaign",
          "campaign": "[LEAD][QUENTE][24][MAR]",
          "content": "2024032812H",
          "term": "PROMO10OFF"
        }
      },
      "billingAddress": {
        "countryCode": "BR",
        "state": "São Paulo",
        "city": "São Paulo",
        "neighborhood": "Bela Vista",
        "street": "Av. Paulista",
        "complement": "MASP",
        "number": "1578",
        "postalCode": "01310-200"
      },
      "saleDate": "2024-03-28T20:35:22.671Z",
      "dueDate": "2024-03-28T20:35:16.350Z",
      "createdAt": "2024-03-28T20:35:22.671Z",
      "modifiedAt": "2024-03-28T20:35:33.512Z",
      "version": 8
    },
    "refund": {
      "id": "lSEqN7PtlTk1lt4OIQ7j",
      "description": "Produto não respondeu com as expectativas.",
      "status": "canceled",
      "isAutoAccepted": true,
      "createdAt": "2024-03-30T12:42:12.512Z",
      "updatedAt": "2024-03-30T12:42:12.512Z"
    }
    "user": {
      "id": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Solicitação de Reembolso rejeitada

Evento disparado quando uma solicitação de reembolso é rejeitada pelo vendedor.

{
  "type": "refund_request.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" }]
      }]
    }],
    "invoice": {
      "id": "7614b1bb-1d1a-43ba-890c-50d74216eb56",
      "subscriptionId": "d7ab5027-5bca-476c-ac29-68f1359ee6ca",
      "payerId": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "sellerId": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
      "installments": 12,
      "paymentMethod": "credit_card",
      "currency": "BRL",
      "type": "sell",
      "status": "paid",
      "statusAt": [
        {
          "status": "unpaid",
          "when": "2024-03-28T20:35:22.671Z"
        },
        {
          "status": "paid",
          "when": "2024-03-28T20:35:33.512Z"
        }
      ],
      "amount": {
        "subtotalCents": 120000,
        "discountCents": 24000,
        "prorataCents": 0,
        "installmentFeeCents": 16320,
        "totalCents": 112320
      },
      "receivers": [
        {
          "id": "platform-identity",
          "name": "Hubla Tecnologia LTDA",
          "email": "suporte@hub.la",
          "phone": "+5531999715693",
          "role": "platform",
          "paysForFees": false,
          "totalCents": 25778
        },
        {
          "id": "onVILjt4hEhXIdCrvCXBUpcBuvk2",
          "name": "Victor Lott",
          "email": "lott@hub.la",
          "phone": "+5533988891169",
          "role": "seller",
          "paysForFees": true,
          "totalCents": 86542
        }
      ],
      "firstPaymentSession": {
        "ip": "220.172.165.140",
        "utm": {
          "source": "email",
          "medium": "active-campaign",
          "campaign": "[LEAD][QUENTE][24][MAR]",
          "content": "2024032812H",
          "term": "PROMO10OFF"
        }
      },
      "billingAddress": {
        "countryCode": "BR",
        "state": "São Paulo",
        "city": "São Paulo",
        "neighborhood": "Bela Vista",
        "street": "Av. Paulista",
        "complement": "MASP",
        "number": "1578",
        "postalCode": "01310-200"
      },
      "saleDate": "2024-03-28T20:35:22.671Z",
      "dueDate": "2024-03-28T20:35:16.350Z",
      "createdAt": "2024-03-28T20:35:22.671Z",
      "modifiedAt": "2024-03-28T20:35:33.512Z",
      "version": 8
    },
    "refund": {
      "id": "lSEqN7PtlTk1lt4OIQ7j",
      "description": "Produto não respondeu com as expectativas.",
      "feedback": "Usuário consumiu o conteúdo e passou do prázo de 7 dias."
      "status": "rejected",
      "isAutoAccepted": false,
      "createdAt": "2024-03-30T12:42:12.512Z",
      "updatedAt": "2024-03-30T12:42:12.512Z"
    }
    "user": {
      "id": "J0kmLJmCj1TO4m3pqW0GDlEjROQ2",
      "firstName": "John",
      "lastName": "Doe",
      "document": "08351973955",
      "email": "john.doe@hub.la",
      "phone": "+5511988646782"
    }
  },
  "version": "2.0.0"
}

Propriedades

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

type string

Tipo do evento de Webhook

Valores possíveis
Descrição

refund_request.created

Solicitação de Reembolso criada

refund_request.accepted

Solicitação de Reembolso aceita

refund_request.canceled

Solicitação de Reembolso cancelado

refund_request.rejected

Solicitação de Reembolso rejeitado


version string

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


event.product.id string

Identificador único do produto


event.product.name string

Nome do produto no momento da compra


event.invoice.billingAddress object

Representa as informações de endereço capturadas do comprador no momento da compra, essas informações são opcionais dependendo da configuração dos campos obrigatórios no checkout.


event.invoice.billingAddress.countryCode string

Código do país seguindo o ISO 3166-1 alpha-2


event.invoice.billingAddress.state string

Nome do estado, condado, província ou região


event.invoice.billingAddress.city string

Nome da cidade, distrito, subúrbio, vila ou vila


event.invoice.billingAddress. string

Nome do bairro


event.invoice.billingAddress.street string

Nome da rua


event.invoice.billingAddress.number string

O número do imóvel


event.invoice.billingAddress.complement string

Complemento que pode ajudar a encontrar o endereço


event.invoice.billingAddress.postalCode string

CEP / Código Postal


event.refund object

Representa as informações da solicitação de reembolso na plataforma.


event.refund.id string

Identificador único da solicitação de reembolso


event.refund.description string

Representa o motivo preenchido pelo comprador


event.refund.feedback string

Representa a devolutiva feita pelo vendedor


event.refund.status string

Status da solicitação de reembolso

Valores possíveis
Descrição

created

Solicitação criada e aguardando aprovação do vendedor

pending

Solicitação aceita e iniciando o processando do reembolso

rejected

Solicitação rejeitada pelo vendedor

accepted

Solicitação aceita e reembolsada

processing

Solicitação aceita e em processamento

canceled

Solicitação cancelada pelo comprador


event.refund.isAutoAccepted string

Representa se o reembolso irá ser aceito automaticamente conforme as regras estipuladas


event.refund.createdAt string

Quando a solicitação foi criada, segue o padrão de ISO-8601 com UTC 0


event.refund.updatedAt string

Representa a data da última atualização da solicitaçã, segue o padrão de ISO-8601 com UTC 0


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

Atualizado

Isto foi útil?