In development. This endpoint does not exist yet. The page is published so you can get to know the
shape and plan the integration — the body below is what will apply when it ships.
Overview
Sends the order invoice with items, subtotal and total, and the button that opens Pix or link payment. Thecontent.type field will be ORDER_DETAILS.
Request body
{
"recipient": { "identifier": "5511999999999" },
"content": {
"type": "ORDER_DETAILS",
"message": "Your order is ready. Review it and complete the payment.",
"footer": "Payment processed by WhatsApp",
"referenceId": "ORD-1042",
"goodsType": "physical-goods",
"currency": "BRL",
"totalAmount": { "value": 50000, "offset": 100 },
"payment": {
"type": "pix_dynamic_code",
"code": "00020126580014br.gov.bcb.pix...",
"merchantName": "Loja do João LTDA",
"keyType": "CNPJ",
"key": "39580525000189"
},
"items": [
{ "retailerId": "SKU-1042", "name": "Basic t-shirt", "amount": { "value": 25000, "offset": 100 }, "quantity": 2 }
]
}
}
Rules
| Rule | Value |
|---|---|
| Amounts | in cents, with offset: 100 — 500.00 is 50000 |
referenceId | unique per order; it is how the status comes back on the webhook |
| Payment method | Pix with a dynamic code, or a payment link |
| Account | must be enabled for payments in Brazil |