API atual/Referência completa/WhatsApp: atendimento

Cobrança por PIX e painel do cliente

Gera uma cobrança PIX e a envia na conversa, lista as cobranças e mostra o carrinho e os pedidos do cliente.

O atendente pode cobrar direto na conversa: a plataforma gera um PIX com código copia e cola e o envia ao cliente, como imagem de QR code quando consegue, ou como texto. Também é possível consultar o painel do cliente daquele telefone (carrinho aberto e pedidos) para atender com contexto.

Criar cobrança

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/chargeSeller

Gera uma cobrança PIX e a envia ao cliente

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Corpo da requisição

amount_centsintegerobrigatório

Valor em centavos (15990 = R$ 159,90). Deve ser maior que 0.

descriptionstring

Descrição mostrada ao cliente. Omitido vale Cobrança.

order_idstring

Número do pedido a que a cobrança se refere. Livre, só para referência.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/charge" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "amount_cents": 15990,
  "description": "Pedido 1042",
  "order_id": "PEDIDO-20261010-0004"
}'

Resposta

200Cobrança criada

json

{
  "id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70",
  "thread_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
  "amount_cents": 15990,
  "description": "Pedido 1042",
  "txid": "VND0123456789ABCDEF",
  "brcode": "00020126580014br.gov.bcb.pix0136...",
  "status": "P",
  "created_at": "2026-10-10T15:00:00Z"
}

Campos da resposta

iduuid

Id da cobrança.

thread_iduuid

Conversa.

order_idstring

Pedido referenciado. Omitido se não informado.

amount_centsinteger

Valor em centavos.

descriptionstring

Descrição.

txidstring

Identificador da cobrança PIX.

brcodestring

Código copia e cola do PIX.

statusstring

PC

P aguardando pagamento, C pago.

paid_atstring

Quando foi paga (RFC 3339). Omitido enquanto P.

created_atstring

Criação (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
400	`amount_cents` ausente, 0 ou negativo, ou corpo que não é JSON.	`{"error":"amount_cents required"}`
502	A loja não tem PIX configurado, ou o provedor falhou. Também cobre uma conversa inexistente.	`{"error":"whatsappcoex: pix provider not configured"}`

Listar cobranças

GET/api/v1/vendor/whatsapp-confluence/threads/{id}/chargesSeller

Lista as cobranças da conversa

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/charges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Cobranças

json

{
  "charges": [
    {
      "id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70",
      "thread_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
      "amount_cents": 15990,
      "description": "Pedido 1042",
      "txid": "VND0123456789ABCDEF",
      "brcode": "00020126580014br.gov.bcb.pix0136...",
      "status": "P",
      "created_at": "2026-10-10T15:00:00Z"
    }
  ]
}

Campos da resposta

chargesarray

Cobranças da conversa, as mais novas primeiro, com os campos de Criar cobrança.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`
500	`id` não é um UUID válido (o corpo traz um texto de erro bruto do banco, não uma mensagem limpa) ou falha interna.	`{"error":"..."}`

Painel do cliente

Junta, para o telefone da conversa, o carrinho aberto no WhatsApp, os últimos 30 pedidos e o cliente da loja ligado a ele (quando existe). Serve para o atendente ver o que o cliente já escolheu e comprou.

GET/api/v1/vendor/whatsapp-confluence/threads/{id}/commerceSeller

Mostra o carrinho aberto e os pedidos do telefone

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/commerce" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Painel

json

{
  "phone": "5511987654321",
  "cart": null,
  "orders": [],
  "user": {
    "user_id": "f12f30a9-cbec-40ba-98f1-b7fa8f2e8e10",
    "name": "Maria Souza",
    "company": ""
  }
}

Campos da resposta

phonestring

Telefone da conversa.

cartobject

Carrinho aberto com seus itens e totais. null quando está vazio.

ordersarray

Até 30 pedidos do telefone. Vazio quando não há.

userobject

user_id, name e company do cliente ligado ao telefone. Omitido quando nenhum cliente é encontrado.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`

Veja também

API atual/Referência completa/WhatsApp: atendimento

Cobrança por PIX e painel do cliente

Gera uma cobrança PIX e a envia na conversa, lista as cobranças e mostra o carrinho e os pedidos do cliente.

Criar cobrança

POST/api/v1/vendor/whatsapp-confluence/threads/{id}/chargeSeller

Gera uma cobrança PIX e a envia ao cliente

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Corpo da requisição

amount_centsintegerobrigatório

Valor em centavos (15990 = R$ 159,90). Deve ser maior que 0.

descriptionstring

Descrição mostrada ao cliente. Omitido vale Cobrança.

order_idstring

Número do pedido a que a cobrança se refere. Livre, só para referência.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/charge" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "amount_cents": 15990,
  "description": "Pedido 1042",
  "order_id": "PEDIDO-20261010-0004"
}'

Resposta

200Cobrança criada

json

{
  "id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70",
  "thread_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
  "amount_cents": 15990,
  "description": "Pedido 1042",
  "txid": "VND0123456789ABCDEF",
  "brcode": "00020126580014br.gov.bcb.pix0136...",
  "status": "P",
  "created_at": "2026-10-10T15:00:00Z"
}

Campos da resposta

iduuid

Id da cobrança.

thread_iduuid

Conversa.

order_idstring

Pedido referenciado. Omitido se não informado.

amount_centsinteger

Valor em centavos.

descriptionstring

Descrição.

txidstring

Identificador da cobrança PIX.

brcodestring

Código copia e cola do PIX.

statusstring

PC

P aguardando pagamento, C pago.

paid_atstring

Quando foi paga (RFC 3339). Omitido enquanto P.

created_atstring

Criação (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
400	`amount_cents` ausente, 0 ou negativo, ou corpo que não é JSON.	`{"error":"amount_cents required"}`
502	A loja não tem PIX configurado, ou o provedor falhou. Também cobre uma conversa inexistente.	`{"error":"whatsappcoex: pix provider not configured"}`

Listar cobranças

GET/api/v1/vendor/whatsapp-confluence/threads/{id}/chargesSeller

Lista as cobranças da conversa

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/charges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Cobranças

json

{
  "charges": [
    {
      "id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70",
      "thread_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
      "amount_cents": 15990,
      "description": "Pedido 1042",
      "txid": "VND0123456789ABCDEF",
      "brcode": "00020126580014br.gov.bcb.pix0136...",
      "status": "P",
      "created_at": "2026-10-10T15:00:00Z"
    }
  ]
}

Campos da resposta

chargesarray

Cobranças da conversa, as mais novas primeiro, com os campos de Criar cobrança.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`
500	`id` não é um UUID válido (o corpo traz um texto de erro bruto do banco, não uma mensagem limpa) ou falha interna.	`{"error":"..."}`

Painel do cliente

GET/api/v1/vendor/whatsapp-confluence/threads/{id}/commerceSeller

Mostra o carrinho aberto e os pedidos do telefone

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id da conversa (id de Listar conversas).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/threads/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/commerce" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Painel

json

{
  "phone": "5511987654321",
  "cart": null,
  "orders": [],
  "user": {
    "user_id": "f12f30a9-cbec-40ba-98f1-b7fa8f2e8e10",
    "name": "Maria Souza",
    "company": ""
  }
}

Campos da resposta

phonestring

Telefone da conversa.

cartobject

Carrinho aberto com seus itens e totais. null quando está vazio.

ordersarray

Até 30 pedidos do telefone. Vazio quando não há.

userobject

user_id, name e company do cliente ligado ao telefone. Omitido quando nenhum cliente é encontrado.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não é um seller, ou o seller ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`
404	Conversa de outro seller. Um id desconhecido também dá 404 em algumas rotas, mas 200 ou 502 em outras quando não há escopo de seller (veja a visão geral da seção).	`{"error":"thread not found"}`