--- updatedAt: 2026-06-26T07:18:18.000Z agentTools: projectIndex: https://partner-docs.gupshup.io/llms.txt --- # PIX Session Message
> 📘 Note: > > 1. Use the `recipient` parameter only when BSUID is enabled for the app. > 2. When both `to` and `recipient` fields are used in the payload, the `to` field gets the priority. ## Request Parameters
Key Description Value Data type Required/Optional Constraints
Authorization Access Token for the application \{\{PARTNER_APP_TOKEN}} String Required Should be a valid Partner App Access Token
appId App ID to fetch the access token \{\{APP_ID}} String Required The Id should be a valid app Id of Gupshup.
messaging_product Messaging product whatsapp String Required
recipient_type Recipient type individual String Required
to Destination phone number where the message needs to be sent 91785876xxxx String Required (Can be optional if BSUID is enabled for the app and recipient parameter is used instead) Must be a valid phone number
recipient Destination BSUID where the message needs to be sent IN.461449821882xxxx String Optional Must be a valid BSUID
type Messaging type text String Required Type should be interactive to send interactive message.
interactive Add interactive body "interactive": \{\} object Required Key should be a interactive to send interactive message.
## Sample Request ```curl curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v3/message' \ --header 'Authorization: {{PARTNER_APP_TOKEN}}' \ --header 'Content-Type: application/json' \ --data '{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": {{destinationNumber}}, "recipient": "{{BSUID}}", "type": "interactive", "interactive": { "type": "order_details", "body": { "text": "Your message content" }, "action": { "name": "review_and_pay", "parameters": { "reference_id": "987654333", "type": "digital-goods", "payment_type": "br", "payment_settings": [ { "type": "pix_dynamic_code", "pix_dynamic_code": { "code": "00020101021226.gov.bcb.pix.example.com...", "merchant_name": "Account holder name", "key": "39580525000189", "key_type": "CNPJ" } } ], "currency": "BRL", "total_amount": { "value": 50000, "offset": 100 }, "order": { "status": "pending", "tax": { "value": 0, "offset": 100, "description": "optional text" }, "items": [ { "retailer_id": "1234567", "name": "Cake", "amount": { "value": 50000, "offset": 100 }, "quantity": 1 } ], "subtotal": { "value": 50000, "offset": 100 } } } } } }' ``` ## Sample Response ```json { "messages": [ { "id": "GUPSHUP_MESSAGE_ID" } ], "messaging_product": "whatsapp", "contacts": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] } ``` ## Status Codes
Status Code Response Comments
**Success**
200 \{ "messages":[\{"id": "GUPSHUP_MESSAGE_ID" } ], "messaging_product": "whatsapp", "contacts": [ \{ "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] }
**Error**
400 \{ "message": "Callback Billing must be enabled for this API",\ "status": "error"} if Callback billing is not enabled for the app
400 \{ "message": "Invalid App Details", "status": "error"} if app details are not found
401 \{ "status": "error", "message": "Authentication Failed"} When API key authentication fails
# OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Partner Portal PIX Send Message Apis", "version": "1.0.0" }, "servers": [ { "url": "https://partner.gupshup.io" } ], "paths": { "/partner/app/{appId}/v3/message": { "post": { "tags": [ "default" ], "summary": "PIX Session Message", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "messaging_product": "whatsapp", "recipient_type": "individual", "to": "5511972932562", "type": "interactive", "interactive": { "type": "order_details", "body": { "text": "Your message content" }, "action": { "name": "review_and_pay", "parameters": { "reference_id": "55535", "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/f0628261-cf9e-4aca-861a-f9a7c591237b5204000053039865802BR5925VINICIUS SOARES DA SILVEI6013Nao_informado62070503***63045EE5", "merchant_name": "Account holder name", "key": "2461684000xxxx", "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 } } } } } } } } } }, "parameters": [ { "name": "Authorization", "in": "header", "schema": { "type": "string" }, "description": "Your app token, please refer [**Get access token api**](https://partner-docs.gupshup.io/reference/get_partner-app-appid-token#/) to get the token from partner documentation.", "example": "sk_61b3021c97214370b341f8baaae0xxxx", "required": true }, { "name": "appId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "Unique identifier of the app.", "example": "9e97650d-xxxx-xxxx-xxxx-4cdf47c3fa68" } ], "responses": { "200": { "description": "Successful response", "content": { "application/octet-stream": { "examples": { "exampleFromExisting200": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Callback Billing must be enabled for this API" }, "status": { "type": "string", "example": "error" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Authentication Failed" }, "status": { "type": "string", "example": "error" } } } } } } } } } } } ```