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>",
        "payment_type": "br",
        "payment_settings": [
          {
            "pix_dynamic_code": {
              "code": "<string>",
              "merchant_name": "<string>",
              "key": "<string>"
            },
            "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>"
          }
        }
      }
    }
  }
}
'
import requests

url = "https://messenger-public-api.cogfy.com/messages/interactive/order_details"

payload = {
"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>",
"payment_type": "br",
"payment_settings": [
{
"pix_dynamic_code": {
"code": "<string>",
"merchant_name": "<string>",
"key": "<string>"
},
"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>"
}
}
}
}
}
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from: '<string>',
to: '<string>',
interactive: {
type: 'order_details',
header: {type: 'image'},
body: JSON.stringify({text: '<string>'}),
footer: {text: '<string>'},
action: {
name: 'review_and_pay',
parameters: {
reference_id: '<string>',
payment_type: 'br',
payment_settings: [
{
pix_dynamic_code: {code: '<string>', merchant_name: '<string>', key: '<string>'},
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>'
}
}
}
}
}
})
};

fetch('https://messenger-public-api.cogfy.com/messages/interactive/order_details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://messenger-public-api.cogfy.com/messages/interactive/order_details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'payment_type' => 'br',
'payment_settings' => [
[
'pix_dynamic_code' => [
'code' => '<string>',
'merchant_name' => '<string>',
'key' => '<string>'
],
'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>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://messenger-public-api.cogfy.com/messages/interactive/order_details"

payload := strings.NewReader("{\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"interactive\": {\n \"type\": \"order_details\",\n \"header\": {\n \"type\": \"image\"\n },\n \"body\": {\n \"text\": \"<string>\"\n },\n \"footer\": {\n \"text\": \"<string>\"\n },\n \"action\": {\n \"name\": \"review_and_pay\",\n \"parameters\": {\n \"reference_id\": \"<string>\",\n \"payment_type\": \"br\",\n \"payment_settings\": [\n {\n \"pix_dynamic_code\": {\n \"code\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"key\": \"<string>\"\n },\n \"payment_link\": {\n \"uri\": \"<string>\"\n },\n \"boleto\": {\n \"digitable_line\": \"<string>\"\n }\n }\n ],\n \"currency\": \"BRL\",\n \"total_amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"order\": {\n \"status\": \"pending\",\n \"catalog_id\": \"<string>\",\n \"expiration\": {\n \"timestamp\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"items\": [\n {\n \"retailer_id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"quantity\": 123,\n \"sale_amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n }\n }\n ],\n \"subtotal\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"tax\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"shipping\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"discount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\",\n \"discount_program_name\": \"<string>\"\n }\n }\n }\n }\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://messenger-public-api.cogfy.com/messages/interactive/order_details")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"interactive\": {\n \"type\": \"order_details\",\n \"header\": {\n \"type\": \"image\"\n },\n \"body\": {\n \"text\": \"<string>\"\n },\n \"footer\": {\n \"text\": \"<string>\"\n },\n \"action\": {\n \"name\": \"review_and_pay\",\n \"parameters\": {\n \"reference_id\": \"<string>\",\n \"payment_type\": \"br\",\n \"payment_settings\": [\n {\n \"pix_dynamic_code\": {\n \"code\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"key\": \"<string>\"\n },\n \"payment_link\": {\n \"uri\": \"<string>\"\n },\n \"boleto\": {\n \"digitable_line\": \"<string>\"\n }\n }\n ],\n \"currency\": \"BRL\",\n \"total_amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"order\": {\n \"status\": \"pending\",\n \"catalog_id\": \"<string>\",\n \"expiration\": {\n \"timestamp\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"items\": [\n {\n \"retailer_id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"quantity\": 123,\n \"sale_amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n }\n }\n ],\n \"subtotal\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"tax\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"shipping\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"discount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\",\n \"discount_program_name\": \"<string>\"\n }\n }\n }\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://messenger-public-api.cogfy.com/messages/interactive/order_details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"interactive\": {\n \"type\": \"order_details\",\n \"header\": {\n \"type\": \"image\"\n },\n \"body\": {\n \"text\": \"<string>\"\n },\n \"footer\": {\n \"text\": \"<string>\"\n },\n \"action\": {\n \"name\": \"review_and_pay\",\n \"parameters\": {\n \"reference_id\": \"<string>\",\n \"payment_type\": \"br\",\n \"payment_settings\": [\n {\n \"pix_dynamic_code\": {\n \"code\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"key\": \"<string>\"\n },\n \"payment_link\": {\n \"uri\": \"<string>\"\n },\n \"boleto\": {\n \"digitable_line\": \"<string>\"\n }\n }\n ],\n \"currency\": \"BRL\",\n \"total_amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"order\": {\n \"status\": \"pending\",\n \"catalog_id\": \"<string>\",\n \"expiration\": {\n \"timestamp\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"items\": [\n {\n \"retailer_id\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"quantity\": 123,\n \"sale_amount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n }\n }\n ],\n \"subtotal\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"tax\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"shipping\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\"\n },\n \"discount\": {\n \"value\": 123,\n \"offset\": 100,\n \"description\": \"<string>\",\n \"discount_program_name\": \"<string>\"\n }\n }\n }\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>"
}

Authorizations

api-key
string
header
required

Body

application/json
from
string
to
string
interactive
object

Response

200 - application/json

Interactive order details message sent successfully

id
string