Documentação dos Webhooks na Frendz
Seja bem-vindo(a) à documentação dos webhooks da FRENDZ.
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.
Todos os valores financeiros são enviados como INTEGER em centavos, ou seja, 11094 significa R$ 110,94.
| status
{
"token": "ax1yevakvi",
"event": "transaction",
"created_at": "2025-02-15T20:55:53.000000Z",
"paid_at": "2025-02-15T20:56:47.000000Z",
"refund_at": null,
"platform": "Frendz",
"status": "paid",
"method": "pix",
"customer": {
"id": "cv9oqec8ax",
"name": "Tatiana",
"email": "thaty-oliver@hotmail.com.br",
"phone": "+5511973304205",
"phone_number": "+5511973304205",
"document": "21327803828",
"zip_code": "",
"street_name": null,
"number": null,
"complement": null,
"neighborhood": null,
"city": null,
"state": null
},
"affiliate": {
"id": null,
"name": null,
"email": null,
"phone_number": null
},
"transaction": {
"id": "my3lnwror0",
"status": "paid",
"method": "pix",
"tracking_code": null,
"amount": "1990",
"net_amount": "1851",
"url": "https://go.frendz.com.br/customer/my3lnwror0",
"billet": {
"url": null,
"barcode": null,
"expires_at": null
},
"pix": {
"code": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/1bc6c8af-fc93-4803-aef5-3c6dd78c6fe05204000053039865802BR5925GROWTH_DIGITAL_MARKETING_6009SAO_PAULO62070503***6304D44F",
"url": "https://go.frendz.com.br/customer/my3lnwror0",
"expires_at": null
}
},
"offer": {
"hash": "44jtn",
"title": "Back redirect",
"price": "1990"
},
"items": [
{
"hash": "a5t6meggny",
"product_hash": "qymyh8exux",
"title": "Planos de Aula BNCC",
"price": "1990",
"quantity": 1,
"cover": "https://mgatewaysaeast1apibucket.s3.sa-east-1.amazonaws.com/1305549790/products/dsyvdknkhwglqpmu70pjpitqb",
"operation_type": 1
}
],
"tracking": {
"src": "",
"utm_source": "FB",
"utm_campaign": "BNCC [R$10] CBO 07 — — Cópia|120216629881540488",
"utm_medium": "AD MISTO [Pedagogia] Insta/Face|120216629881910488",
"utm_term": "Instagram_Stories",
"utm_content": "01|120216629882330488"
},
"ip": "2804:1b3:ac01:da6c:e0c7:ba35:ab25:9808",
"fbp": "fb.2.1739652885321.831157714809471026",
"fbc": "fb.2.1739652885290.PAZXh0bgNhZW0BMABhZGlkAasYY1Sp6UgBpudLCE2BUAyWmr2FgrILI3YQkNVbyT7iDdMgB5pdM9zuVwaTavVdReR_ww_aem_7pyq5iiL_W2Q9v4WaX2dKg"
}
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.
Todos os valores financeiros são enviados como INTEGER em centavos, ou seja, 11094 significa R$ 110,94.
Status do Pagamento
| status
descrição |
---|
processing |
authorized |
paid |
refunded |
waiting_payment ** |
refused |
antifraud |
chargedback |
Métodos de Pagamento
Status | Descrição |
---|---|
credit_card | Cartão de Crédito |
billet | Boleto |
pix | Pix |
Exemplo de webhook
{
"token": "ax1yevakvi",
"event": "transaction",
"created_at": "2025-02-15T20:55:53.000000Z",
"paid_at": "2025-02-15T20:56:47.000000Z",
"refund_at": null,
"platform": "Frendz",
"status": "paid",
"method": "pix",
"customer": {
"id": "cv9oqec8ax",
"name": "Tatiana",
"email": "thaty-oliver@hotmail.com.br",
"phone": "+5511973304205",
"phone_number": "+5511973304205",
"document": "21327803828",
"zip_code": "",
"street_name": null,
"number": null,
"complement": null,
"neighborhood": null,
"city": null,
"state": null
},
"affiliate": {
"id": null,
"name": null,
"email": null,
"phone_number": null
},
"transaction": {
"id": "my3lnwror0",
"status": "paid",
"method": "pix",
"tracking_code": null,
"amount": "1990",
"net_amount": "1851",
"url": "https://go.frendz.com.br/customer/my3lnwror0",
"billet": {
"url": null,
"barcode": null,
"expires_at": null
},
"pix": {
"code": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/1bc6c8af-fc93-4803-aef5-3c6dd78c6fe05204000053039865802BR5925GROWTH_DIGITAL_MARKETING_6009SAO_PAULO62070503***6304D44F",
"url": "https://go.frendz.com.br/customer/my3lnwror0",
"expires_at": null
}
},
"offer": {
"hash": "44jtn",
"title": "Back redirect",
"price": "1990"
},
"items": [
{
"hash": "a5t6meggny",
"product_hash": "qymyh8exux",
"title": "Planos de Aula BNCC",
"price": "1990",
"quantity": 1,
"cover": "https://mgatewaysaeast1apibucket.s3.sa-east-1.amazonaws.com/1305549790/products/dsyvdknkhwglqpmu70pjpitqb",
"operation_type": 1
}
],
"tracking": {
"src": "",
"utm_source": "FB",
"utm_campaign": "BNCC [R$10] CBO 07 — — Cópia|120216629881540488",
"utm_medium": "AD MISTO [Pedagogia] Insta/Face|120216629881910488",
"utm_term": "Instagram_Stories",
"utm_content": "01|120216629882330488"
},
"ip": "2804:1b3:ac01:da6c:e0c7:ba35:ab25:9808",
"fbp": "fb.2.1739652885321.831157714809471026",
"fbc": "fb.2.1739652885290.PAZXh0bgNhZW0BMABhZGlkAasYY1Sp6UgBpudLCE2BUAyWmr2FgrILI3YQkNVbyT7iDdMgB5pdM9zuVwaTavVdReR_ww_aem_7pyq5iiL_W2Q9v4WaX2dKg"
}
Atualizado em: 05/03/2025
Obrigado!