Seja bem vindo(a) a documentação dos webhooks da Kiwify.
<aside>
💡 Os webhooks enviam uma requisição POST com informações sobre cada pedido. O seu sistema deve retornar uma resposta 2xx
confirmando o recebimento. Caso contrário, o webhook será reenviado até 5 vezes.
</aside>
<aside> 💡 Há um limite de tempo de 40 segundos em que aguardamos a confirmação do recebimento da requisição por parte do seu sistema.
</aside>
{
"order_id": "da292c35-c6fc-44e7-ad19-ff7865bc2d89",
"order_ref": "Quzqwus",
"order_status": "paid", //Status da venda
"payment_method": "credit_card",
"store_id": "JKzixndUxOr68LJ",
"payment_merchant_id": "10869585",
"installments": 1,
"card_type": "mastercard",
"card_last4digits": "6411",
"card_rejection_reason": null,
"pix_code": null,
"pix_expiration": null,
"boleto_URL": null,
"sale_type": "producer",
"created_at": "2020-12-21 10:46",
"updated_at": "2020-12-21 10:46",
"webhook_event_type": "order_approved",
"Product": {
"product_id": "acfe6050-4387-11eb-85a0-43a3ebec8277",
"product_name": "New Subscription"
},
"Customer": {
"full_name": "Mario Chase",
"first_name": "Mario",
"email": "[email protected]",
"mobile": null,
"CPF": null,
"ip": "192.168.0.1"
},
"Commissions": {
"charge_amount": "12424",
"product_base_price": "12424",
"kiwify_fee": "1117",
"commissioned_stores": [
{
"id": "b34b0051-14c3-4998-af0c-25f0def7b4b4",
"type": "producer",
"custom_name": "New",
"email": "[email protected]",
"value": "11307"
}
],
"my_commission": "11307",
"funds_status": null,
"estimated_deposit_date": null,
"deposit_date": null
},
"TrackingParameters":{
"src": null,
"sck": null,
"utm_source": null,
"utm_medium": null,
"utm_campaign": null,
"utm_content": null,
"utm_term": null
},
"Subscription":{
"start_date":"2020-12-21T13:46:20.508Z",
"next_payment":"2021-01-20T13:46:19.913Z",
"status":"active",
"plan":{
"id":"cc8dae72-3927-4a45-909c-8b01482dc1fa",
"name":"7 Day",
"frequency":"monthly",
"qty_charges":0
},
"charges":{
"completed":[
{
"order_id":"da292c35-c6fc-44e7-ad19-ff7865bc2d89",
"amount":11307,
"status":"paid",
"installments":1,
"card_type":"mastercard",
"card_last_digits":"6411",
"card_first_digits":"553527",
"created_at":"2020-12-21T13:46:20.596Z"
}
],
"future":[
{
"charge_date":"2021-01-20T13:46:19.913Z"
},
{
"charge_date":"2021-02-20T13:46:19.913Z"
},
{
"charge_date":"2021-03-20T13:46:19.913Z"
}
]
}
},
"subscription_id":"3a8d274e-1351-4678-b653-10be23d5d218"
},
"access_url": "<https://dashboard.kiwify.com.br/student/password/TOXJPgwJ0NcapWz18sWsq0Nd2hk3SrLfsBxnA?redirect=/course/84a4b499-f888-4a41-ac44-38f53a86453d>"
}
<aside>
⚠️ Os objetos Subscription
, charges
e o parâmetro subscription_id
só são enviados caso a venda seja ligada a uma assinatura recorrente.
</aside>
<aside>
⚠️ Os objetos event_tickets
e event_batch
só são enviados caso a venda seja ligada a um produto de evento presencial.
</aside>
<aside>
💡 O parâmetro access_url
é o link de criar senha na área de membros da Kiwify. Você pode usar ele para enviar a URL de acesso a partir do seu sistema de e-mail, SMS, WhatsApp, entre outros. Se o usuário já tiver criado a senha, essa url irá somente redirecionar para o login.
</aside>
<aside>
💰 Todos os valores financeiros são enviados como INTEGER em centavos, ou seja, 11094
significa R$ 110,94
</aside>
Status de pagamento (order_status)
Se você quer liberar o acesso a uma área de membros própria, você deve checar se o order_status
do webhook é paid
.