Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
order-payment-update
Atualizar pagamento do pedido
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/order-payment-update \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "messageId": "<string>",
  "referenceId": "<string>",
  "orderRequestId": "<string>",
  "orderStatus": "<string>",
  "paymentStatus": "<string>",
  "order": {
    "currency": "<string>",
    "products": [
      {
        "name": "<string>",
        "value": 123,
        "quantity": 123,
        "productId": "<string>",
        "isCustomItem": true
      }
    ],
    "discount": 123,
    "tax": 123,
    "shipping": 123
  }
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá enviar mensagens de atualização do pagamento dos pedidos enviados.
Este método está disponível apenas para contas Business do WhatsApp.

​
Exemplo no WhatsApp

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
Telefone do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
messageId
string
obrigatório
ID da mensagem original do pedido no WhatsApp
​
referenceId
string
obrigatório
ID de referência do pedido (obtido via webhook)
​
orderRequestId
string
obrigatório
ID de referência da requisição do pedido (obtido via webhook)
​
orderStatus
string
obrigatório
Status do pedido: pending, processing, shipped, completed ou canceled
​
paymentStatus
string
obrigatório
Status do pagamento: pending ou paid
​
order
object
obrigatório
Dados do pedido

​
Opcionais

​
message
string
Mensagem de texto da atualização do pedido

​
Request Body

{
  "phone": "554499999999",
  "messageId": "3EB0F91BBA791BB0A787FC",
  "message": "Mensagem de texto da atualização do pedido",
  "referenceId": "4N8FCTW1WM6",
  "orderRequestId": "4N8FCTW22W4",
  "orderStatus": "processing",
  "paymentStatus": "paid",
  "order": {
    "currency": "BRL",
    "discount": 10,
    "tax": 10,
    "shipping": 5,
    "products": [
      {
        "value": 150,
        "quantity": 2,
        "name": "order 1",
        "isCustomItem": true,
        "productId": "custom-item-4N8FCTW23N7"
      },
      {
        "productId": "23940797548900636",
        "value": 150,
        "quantity": 2,
        "name": "order 2",
        "isCustomItem": false
      }
    ]
  }
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.