Skip to main content
POST
/
messages
/
interactive
/
order_details
Send interactive order details message
curl --request POST \
  --url https://messenger-public-api.cogfy.com/messages/interactive/order_details \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "from": "<string>",
  "to": "<string>",
  "interactive": {
    "type": "order_details",
    "header": {
      "type": "image"
    },
    "body": {
      "text": "<string>"
    },
    "footer": {
      "text": "<string>"
    },
    "action": {
      "name": "review_and_pay",
      "parameters": {
        "reference_id": "<string>",
        "type": "digital-goods",
        "payment_type": "br",
        "payment_settings": [
          {
            "type": "pix_dynamic_code",
            "pix_dynamic_code": {
              "code": "<string>",
              "merchant_name": "<string>",
              "key": "<string>",
              "key_type": "CPF"
            },
            "payment_link": {
              "uri": "<string>"
            },
            "boleto": {
              "digitable_line": "<string>"
            }
          }
        ],
        "currency": "BRL",
        "total_amount": {
          "value": 123,
          "offset": 100,
          "description": "<string>"
        },
        "order": {
          "status": "pending",
          "catalog_id": "<string>",
          "expiration": {
            "timestamp": "<string>",
            "description": "<string>"
          },
          "items": [
            {
              "retailer_id": "<string>",
              "name": "<string>",
              "amount": {
                "value": 123,
                "offset": 100,
                "description": "<string>"
              },
              "quantity": 123,
              "sale_amount": {
                "value": 123,
                "offset": 100,
                "description": "<string>"
              }
            }
          ],
          "subtotal": {
            "value": 123,
            "offset": 100,
            "description": "<string>"
          },
          "tax": {
            "value": 123,
            "offset": 100,
            "description": "<string>"
          },
          "shipping": {
            "value": 123,
            "offset": 100,
            "description": "<string>"
          },
          "discount": {
            "value": 123,
            "offset": 100,
            "description": "<string>",
            "discount_program_name": "<string>"
          }
        }
      }
    }
  }
}'
{
  "id": "<string>"
}

Authorizations

​
api-key
string
header
required

Body

application/json
​
from
string
​
to
string
​
interactive
object

Response

200 - application/json
​
id
string