API atual/Referência completa/WhatsApp: caixa de entrada

Cobranças PIX

Gera uma cobrança PIX dentro da conversa e lista as cobranças já geradas.

Gerar uma cobrança

O atendente cobra o cliente sem sair da conversa: a plataforma gera um PIX, grava a cobrança e envia o QR code e o copia e cola ao cliente (imagem com legenda ou, se a imagem falhar, só texto).

POST/api/v1/admin/whatsapp-confluence/threads/{id}/chargeAdmin

Gera uma cobrança PIX

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Corpo da requisição

amount_centsintegerobrigatório

Valor em centavos, maior que zero.

descriptionstring

Descrição. Padrão Cobrança.

order_idstring

Número ou id do pedido a que a cobrança se refere.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/charge" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount_cents": 19800, "description": "Pedido 0012", "order_id": "PEDIDO-20261008-0012"}'

Resposta

200Cobrança criada

json

{
  "id": "3e2f7c1a-9d4b-4a65-8c1e-b0a7d5f4e3c2",
  "thread_id": "e661b36c-fe1b-450f-b75b-49d10c1ead48",
  "order_id": "PEDIDO-20261008-0012",
  "amount_cents": 19800,
  "description": "Pedido 0012",
  "txid": "WAC3E2F7C1A9D4B4A65",
  "brcode": "00020126580014br.gov.bcb.pix0136...6304ABCD",
  "status": "P",
  "created_at": "2026-10-10T18:50:00Z"
}

Campos da resposta

iduuid

Id da cobrança.

thread_iduuid

Conversa.

order_idstring

Pedido ligado, se informado.

amount_centsinteger

Valor em centavos (19800 = R$ 198,00).

descriptionstring

Descrição enviada ao cliente.

txidstring

Identificador do PIX.

brcodestring

Código PIX copia e cola.

statusstring

P

P pendente. O acerto automático (marcar como paga) não está implementado nesta rota; ver aviso.

paid_atstring

Quando foi paga. Ausente enquanto pendente.

created_atstring

Criação.

Erros

Status	Quando	Corpo de exemplo
400	`amount_cents` ausente, zero ou negativo, ou JSON inválido.	`{"error":"amount_cents required"}`
502	Provedor PIX não configurado, conversa inexistente ou falha ao gerar.	`{"error":"whatsappcoex: pix provider not configured"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Listar as cobranças

Devolve as cobranças da conversa, da mais nova para a mais antiga. Uma conversa sem cobranças (ou um id desconhecido) devolve lista vazia.

GET/api/v1/admin/whatsapp-confluence/threads/{id}/chargesAdmin

Lista as cobranças da conversa

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/charges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Cobranças

json

{
  "charges": [
    {
      "id": "3e2f7c1a-9d4b-4a65-8c1e-b0a7d5f4e3c2",
      "thread_id": "e661b36c-fe1b-450f-b75b-49d10c1ead48",
      "order_id": "PEDIDO-20261008-0012",
      "amount_cents": 19800,
      "description": "Pedido 0012",
      "txid": "WAC3E2F7C1A9D4B4A65",
      "brcode": "00020126580014br.gov.bcb.pix0136...6304ABCD",
      "status": "P",
      "created_at": "2026-10-10T18:50:00Z"
    }
  ]
}

Campos da resposta

chargesarray

Cobranças da conversa.

charges[].iduuid

Id da cobrança.

charges[].thread_iduuid

Conversa.

charges[].order_idstring

Pedido ligado, se informado.

charges[].amount_centsinteger

Valor em centavos (19800 = R$ 198,00).

charges[].descriptionstring

Descrição enviada ao cliente.

charges[].txidstring

Identificador do PIX.

charges[].brcodestring

Código PIX copia e cola.

charges[].statusstring

P

P pendente. O acerto automático (marcar como paga) não está implementado nesta rota; ver aviso.

charges[].paid_atstring

Quando foi paga. Ausente enquanto pendente.

charges[].created_atstring

Criação.

Erros

Status	Quando	Corpo de exemplo
500	Id que não é UUID, ou falha de leitura.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Veja também

Vender na conversa

API atual/Referência completa/WhatsApp: caixa de entrada

Cobranças PIX

Gera uma cobrança PIX dentro da conversa e lista as cobranças já geradas.

Gerar uma cobrança

O atendente cobra o cliente sem sair da conversa: a plataforma gera um PIX, grava a cobrança e envia o QR code e o copia e cola ao cliente (imagem com legenda ou, se a imagem falhar, só texto).

POST/api/v1/admin/whatsapp-confluence/threads/{id}/chargeAdmin

Gera uma cobrança PIX

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Corpo da requisição

amount_centsintegerobrigatório

Valor em centavos, maior que zero.

descriptionstring

Descrição. Padrão Cobrança.

order_idstring

Número ou id do pedido a que a cobrança se refere.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/charge" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount_cents": 19800, "description": "Pedido 0012", "order_id": "PEDIDO-20261008-0012"}'

Resposta

200Cobrança criada

json

{
  "id": "3e2f7c1a-9d4b-4a65-8c1e-b0a7d5f4e3c2",
  "thread_id": "e661b36c-fe1b-450f-b75b-49d10c1ead48",
  "order_id": "PEDIDO-20261008-0012",
  "amount_cents": 19800,
  "description": "Pedido 0012",
  "txid": "WAC3E2F7C1A9D4B4A65",
  "brcode": "00020126580014br.gov.bcb.pix0136...6304ABCD",
  "status": "P",
  "created_at": "2026-10-10T18:50:00Z"
}

Campos da resposta

iduuid

Id da cobrança.

thread_iduuid

Conversa.

order_idstring

Pedido ligado, se informado.

amount_centsinteger

Valor em centavos (19800 = R$ 198,00).

descriptionstring

Descrição enviada ao cliente.

txidstring

Identificador do PIX.

brcodestring

Código PIX copia e cola.

statusstring

P

P pendente. O acerto automático (marcar como paga) não está implementado nesta rota; ver aviso.

paid_atstring

Quando foi paga. Ausente enquanto pendente.

created_atstring

Criação.

Erros

Status	Quando	Corpo de exemplo
400	`amount_cents` ausente, zero ou negativo, ou JSON inválido.	`{"error":"amount_cents required"}`
502	Provedor PIX não configurado, conversa inexistente ou falha ao gerar.	`{"error":"whatsappcoex: pix provider not configured"}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Listar as cobranças

Devolve as cobranças da conversa, da mais nova para a mais antiga. Uma conversa sem cobranças (ou um id desconhecido) devolve lista vazia.

GET/api/v1/admin/whatsapp-confluence/threads/{id}/chargesAdmin

Lista as cobranças da conversa

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/whatsapp-confluence/threads/e661b36c-fe1b-450f-b75b-49d10c1ead48/charges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Cobranças

json

{
  "charges": [
    {
      "id": "3e2f7c1a-9d4b-4a65-8c1e-b0a7d5f4e3c2",
      "thread_id": "e661b36c-fe1b-450f-b75b-49d10c1ead48",
      "order_id": "PEDIDO-20261008-0012",
      "amount_cents": 19800,
      "description": "Pedido 0012",
      "txid": "WAC3E2F7C1A9D4B4A65",
      "brcode": "00020126580014br.gov.bcb.pix0136...6304ABCD",
      "status": "P",
      "created_at": "2026-10-10T18:50:00Z"
    }
  ]
}

Campos da resposta

chargesarray

Cobranças da conversa.

charges[].iduuid

Id da cobrança.

charges[].thread_iduuid

Conversa.

charges[].order_idstring

Pedido ligado, se informado.

charges[].amount_centsinteger

Valor em centavos (19800 = R$ 198,00).

charges[].descriptionstring

Descrição enviada ao cliente.

charges[].txidstring

Identificador do PIX.

charges[].brcodestring

Código PIX copia e cola.

charges[].statusstring

P

P pendente. O acerto automático (marcar como paga) não está implementado nesta rota; ver aviso.

charges[].paid_atstring

Quando foi paga. Ausente enquanto pendente.

charges[].created_atstring

Criação.

Erros

Status	Quando	Corpo de exemplo
500	Id que não é UUID, ou falha de leitura.	`{"error":"..."}`
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem papel de administrador.	`{"error":"insufficient permissions"}`

Veja também

Vender na conversa