post
https://partner.gupshup.io/partner/bizgate/app//messaging?messageType=pix-template
Send PIX payment template message (Brazil) — one message type of POST /partner/bizgate/app/{appId}/messaging; send the cURL below as shown.
Variant: PIX payment template (Brazil).
Request parameters
Path parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| appId | Identifier of the WhatsApp app the call acts on. | 6f414190-d45c-4671-bca1-fb6c3018cb13 | String | Required |
Body
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| messaging_product | Always "whatsapp". | — | Required | |
| recipient_type | Always "individual"; group recipients are not supported here. | individual | — | Optional |
| to | E.164 without + | 12XXXXXXX92 | — | Required |
| type | text, template, image, … | template | — | Optional |
| template | Required when type=template | — | — | Optional |
curl --request POST \
--url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/messaging' \
--header 'Authorization: Bearer <UT>' \
--header 'Content-Type: application/json' \
--data '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "55XXXXXXXXX62",
"type": "template",
"template": {
"name": "pix_test_template",
"language": {
"policy": "deterministic",
"code": "en"
},
"components": [
{
"type": "button",
"sub_type": "order_details",
"index": 0,
"parameters": [
{
"type": "action",
"action": {
"order_details": {
"reference_id": "001517",
"type": "digital-goods",
"payment_type": "br",
"payment_settings": [
{
"type": "pix_dynamic_code",
"pix_dynamic_code": {
"code": "00020101021226900014br.gov.bcb.pix2568pix.sicoob.com.br/qr/payload/v2/085e4c08-dede-404f-b312-6566c55d4b105204000053039865802BR5925VINICIUS SOARES DA SILVEI6013Nao_informado62070503***63041235",
"merchant_name": "Account holder name",
"key": "24XXXXXXXXXX99",
"key_type": "CNPJ"
}
}
],
"currency": "BRL",
"total_amount": {
"value": 100,
"offset": 100
},
"order": {
"status": "pending",
"tax": {
"value": 0,
"offset": 100,
"description": "optional text"
},
"items": [
{
"retailer_id": "1234567",
"name": "Cake",
"amount": {
"value": 100,
"offset": 100
},
"quantity": 1
}
],
"subtotal": {
"value": 100,
"offset": 100
}
}
}
}
}
]
}
]
}
}
'Sample success response (200)
{
"messages": [
{
"id": "GUPSHUP_MESSAGE_ID"
}
],
"messaging_product": "whatsapp",
"contacts": [
{
"input": "DESTINATION_PHONE_NO",
"wa_id": "DESTINATION_PHONE_NO"
}
]
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…