--- updatedAt: 2026-06-26T06:53:33.000Z agentTools: projectIndex: https://partner-docs.gupshup.io/llms.txt --- # Boleto Message Use this API to send a boleto message to a WhatsApp user.
> 📘 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 Values Data Types 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 order_details String Required
order_details Add interactive body Interactive body 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 'Content-Type: application/json' \ --header 'Authorization: {{PARTNER_APP_TOKEN}}' \ --data '{ "messaging_product": "whatsapp", "recipient_type": "individual", "to": "5511972932562", "recipient": "IN.4614498218826880", "type": "interactive", "interactive": { "type": "order_details", "body": { "text": "Your message content" }, "action": { "name": "review_and_pay", "parameters": { "reference_id": "reference-id-76126787", "type": "digital-goods", "payment_type": "br", "payment_settings": [ { "type": "boleto", "boleto": { "digitable_line": "846600000000440000641009013645834345925078459722" } } ], "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 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** | | | | 401 | \{ "status": "error", "message": "Authentication Failed" }\` | When API key authentication fails | | 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 |