Atualizar a cobrança
PATCH /messages/payment
Manda ao contato uma atualização do pedido de uma cobrança enviada antes (type: payment no POST /messages): o estado do pedido e, se quiser, o pagamento e uma nota. A atualização sai como resposta à cobrança.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Corpo da requisição
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"message_id": {
"type": "string",
"description": "A mensagem: o `id` dela."
},
"status": {
"type": "string",
"enum": [
"payment_requested",
"preparing_to_ship",
"shipped",
"delivered",
"completed",
"canceled"
],
"description": "Novo estado do pedido: `payment_requested` (aguardando pagamento), `preparing_to_ship` (preparando), `shipped` (enviado), `delivered` (entregue), `completed` (concluído) ou `canceled` (cancelado)."
},
"paid": {
"type": "boolean",
"description": "`true` marca como pago; `false`, como pendente. Sem o campo, o pagamento não muda e só sai a atualização do pedido."
},
"note": {
"type": "string",
"description": "Nota que aparece na atualização (até 500 caracteres)."
}
},
"required": [
"message_id",
"status"
]
},
"example": {
"message_id": "3EB0A1B2C3D4E5F60718",
"status": "shipped",
"paid": true,
"note": "Saiu para entrega."
}
}
}
}
Respostas
{
"200": {
"description": "A atualização enviada.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"message_id",
"status"
],
"properties": {
"message_id": {
"type": "string",
"description": "A mensagem de atualização do pedido que o contato recebeu: acompanhe o envio por ela."
},
"status": {
"type": "string",
"description": "O estado do pedido enviado."
},
"paid": {
"type": "boolean",
"description": "O pagamento enviado em `paid` (só quando veio)."
},
"reference_id": {
"type": "string",
"description": "Número do pedido ou da fatura."
},
"update_message_id": {
"type": "string",
"description": "A mensagem de pagamento que o contato recebeu (só quando `paid` veio)."
}
}
},
"example": {
"message_id": "3EB0C9D8E7F6",
"status": "shipped",
"paid": true,
"reference_id": "PED-1234",
"update_message_id": "3EB0D1E2F3"
}
}
}
},
"400": {
"description": "A mensagem não é uma cobrança, ou o pedido é inválido (estado desconhecido, nota com mais de 500 caracteres).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "not_payment",
"message": "A mensagem não é uma cobrança."
}
}
}
},
"401": {
"description": "Token inválido ou ausente.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"404": {
"description": "Mensagem não encontrada.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "not_found",
"message": "Mensagem não encontrada."
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
},
"501": {
"$ref": "#/components/responses/CloudUnsupported"
},
"502": {
"description": "O WhatsApp recusou a atualização. Com `paid`, o pagamento pode ter saído sem o pedido: confira a conversa antes de tentar de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "send_failed",
"message": "Pagamento atualizado, mas o pedido não foi enviado. Confira a conversa antes de tentar de novo."
}
}
}
},
"503": {
"description": "Inbox desconectada do WhatsApp.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "disconnected",
"message": "WhatsApp desconectado."
}
}
}
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Não | Cobrança é só do WhatsApp Web. |
| Não | ||
| Messenger | Não | |
| Telegram | Não |
Eventos que esta rota gera
O que chega no seu webhook (ou em GET /events) depois desta rota.
message.sent: a atualização que o contato recebe
{
"id": "evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H",
"type": "message.sent",
"created_at": "2026-10-17T12:00:00.000Z",
"inbox": {
"id": "r0269625d29bfbd",
"name": "loja",
"phone": "5511888888888",
"channel": "whatsapp_web"
},
"data": {
"message": {
"id": "3EB0D1E2F3",
"chat_id": "5511999999999@s.whatsapp.net",
"author": {
"id": "5511888888888@s.whatsapp.net",
"name": "Loja"
},
"direction": "out",
"sent_by": "api",
"sent_at": "2026-10-17T12:00:00.000Z",
"category": "conversation",
"type": "payment",
"reference_id": "PED-1234",
"text": "Saiu para entrega.",
"payment_status": "shipped"
},
"chat": {
"id": "5511999999999@s.whatsapp.net",
"lid": "123456789012345@lid",
"type": "direct"
}
}
}
Antes e depois (uazapi → Orkesio)
Na uazapi: POST /message/payment/status.
id→message_id(a mensagem da cobrança).- Resposta:
orderStatus→status,referenceId→reference_id,paymentStatusMessageID→update_message_id;paymentChanged,manuale os campos da mensagem enviada saíram.
#/components/schemas/OrkesioError
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
},
"message": {
"type": "string",
"description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
},
"field": {
"type": "string",
"description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
}
},
"required": [
"error",
"message"
],
"additionalProperties": true,
"description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
#/components/responses/RateLimited
{
"description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
"headers": {
"Retry-After": {
"description": "Segundos até poder chamar de novo.",
"schema": {
"type": "integer",
"minimum": 1
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "rate_limited",
"message": "Muitas requisições."
}
}
}
}
#/components/responses/InternalError
{
"description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "internal_error",
"message": "Falha inesperada."
}
}
}
}
#/components/responses/CloudUnsupported
{
"description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unsupported_for_channel",
"message": "Esta rota não está disponível no canal da inbox."
}
}
}
}
Guias relacionados
Visão geral · O que funciona em cada canal · O que muda da uazapi