KiragoInstall

Summary

Send a payment order details message to a specified WhatsApp JID including item information, merchant details, and optional payment methods like PIX or boleto line.

Inputs

• JID (required) — Recipient's JID (e.g., a phone number such as 5511999999999).
• Reference ID (required) — Reference identifier for the order (e.g., REF-123).
• Total (required) — Total amount to be charged for the order; must be greater than 0.
• Item Name (required) — Name of the item being ordered.
• Item Qty (required) — Quantity of the item; must be greater than 0.
• Merchant Name (required) — Name of the merchant or seller.
• PIX Key — Optional PIX key for payment.
• PIX Key Type — Type of PIX key used when PIX Key is provided (e.g., EVP, PHONE, CPF, CNPJ, EMAIL). Defaults to EVP.
• Boleto Line — Optional boleto payment line (digitable line).
• PDF Header URL — Optional URL to a PDF displayed in the message header.
• Body — Optional custom text content to include in the message body.
• Footer — Optional footer text for the message.
• Referral — Optional referral string to track message source (e.g., chat_attachment).
• Share Payment Status — Boolean flag indicating whether to share payment status updates with the recipient.

Output shape

a list with one JSON object per item, each containing the API response of the send order details request

Requires specifying at least one payment method: either PIX Key or Boleto Line. The operation will throw errors if mandatory fields are missing or invalid (e.g., total <= 0, item quantity <= 0). The returned JSON payload confirms sending the order details payment message via Kirago's API.

Examples

Example 1: Send order details payment message

Provide recipient JID, reference ID, total amount, item name and quantity, merchant name, and optionally payment keys and message body texts to send an order details message via WhatsApp.

Links

• n8n community nodes installation guide