Send WhatsApp Pay Messages

sid

String

Account SID (Security Identifier).

HXXXXXXX071IN

Yes

api_key

String

The API Key generated by kaleyra.io.

Ac4XXXXX21f

Yes

to_number

String

A valid WhatsApp number of the recipient. Ensure that the country code is prefixed to the number. (E164 format).

Note: You can add multiple numbers, separate each number using the comma (,).

919886517012

Yes

type

String

Message format for the message. The type must be 'order_details'.

order_details

Yes

channel_name

String

Only the WhatsApp channel is supported for the WhatsApp catalog template.

WhatsApp

Yes

from_number

String

The number registered with WhatsApp business from which the message is to be sent. Ensure that the country code is prefixed to the number. (E164 format).

918045210677

Yes

callback_url

String

Specifies the callback URL to receive notifications regarding the WhatsApp message status (sent, delivered, read, and failed). For more information related to callback profiles, see the Callback profiles page.
The URL can be accessed publicly.
Click here for an example.

https://webhook.site/e5xxxx3f-cxx4-4xx4-axx8-2exxxxxxxx95

No

header

Object

Header content is displayed on top of a message. If a header is not provided, the API uses an image of the first available product as the header.

Message header

No

footer

Object

An object with the footer of the message. The object contains the following field:

text string: Required, if footer is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters

Message footer

No

body

Object

An object with the message body. The object contains the following field:

text string: Required, if the body is present. This is the content of the message.
Emojis and markdown are supported. Maximum length of the body text is 1024 characters.

They`re good for your eye health too

Yes

action

Object

An action that you want the end customer to perform after reading the message.
This action object contains the following fields:
name string: Required.
Must be "review_and_pay".

Parameters object-See Parameters Object description table for information.

See Parameters Object for information

Yes

reference_id

String

Unique ID given by the business.
It is case sensitive and cannot be an empty string. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters.

If there is a need to send multiple order_details messages for the same order, add a sequence number in the reference_id (for example, "BM345A-12") to ensure reference_id uniqueness.

Hello_2abcdxyabxyaab

Yes

type

Object

The type of goods in this order.
The supported options are digital-goods and physical-goods.

digital-goods

Yes

beneficiaries

Array

Required for shipped physical-goods.
Beneficiary information is not shown to users but is needed for legal and compliance reasons.

beneficiary1

No

notes

Object

Only supported for Razorpay payment gateway
The object can be key value pairs with maximum 15 keys and each value limits to 256 characters.

“Key1”:
”value1”, “key2”:
”value2”

No

receipt

String

Only supported for Razorpay payment gateway.
Receipt number that corresponds to this order, set for your internal reference. Maximum length of 40 characters supported with minimum length greater than 0 characters.

receipt-value

No

udf1-4

String

Only supported for PayU payment gateway.
User-defined fields (udf) are used to store any information corresponding to a particular order.
Each UDF field has a maximum character limit of 255.

value1, value2, value3,
value4

No

status

string

The only supported value in the order_details message is 'pending' status.

pending

Yes

type

string

The only supported value is 'quick_pay'.
When this field value is provided, the "Review and Pay" button is hidden and only the "Pay Now" button is shown in the order details bubble.

quick_pay

No

items

Object

This is an object with the list of items for the order that contains the following fields:

1. retailer_id: string
   Optional. Content ID for an item in the order from the catalog.
2. name: string
   Required. The item’s name to be displayed. Cannot exceed 60 characters.
3. image: object
   Optional. Custom image for the item to be displayed to the user. See item image object for information.
   Using this image field will limit the items array to a maximum of 10 items and this cannot be used with retailer_id or catalog_id.
4. amount: amount object with value and offset;
   Required. The price per item.
5. sale_amount: amount object
   Optional. The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount.
6. quantity: integer
   Required. The number of items in this order, this field cannot have a decimal value.
7. country_of_origin: string
   Required, if the catalog_id is not present. The country of origin of the product.
8. importer_name: string
   Required, if the catalog_id is not present. Name of the importer company.
9. importer_adress: string
   Required, if the catalog_id is not present. Address of importer company.

"items":
{
"retailer_id": "6f5gcuihud",
"name": "Bushel of carrots",
"amount":
{
"value": 12.34,
"offset":100
},
"sale_amount": {
"value": 12.34,
"offset": 100
},
"quantity": 1
}
],
"subtotal": {
"value": 12.34,
"offset":100
},
"tax": {
"value": 00,
"offset": 100,
"description": "0%"
},
"shipping": {
"value": 0,
"offset": 100,
"description": "0% off on your order"
},
"discount": {
"value": 0,
"offset": 100,
"description": "0% discount", "discount_program_name": "optional_text"
}
}
}
}

Yes

subtotal

Object

The value must be equal to sum of order.amount.value * order.amount.quantity.
The following fields are part of the subtotal object:

1. offset: integer
   Required. This value must be 100 for INR.
   Offset is a positive integer used to multiply with the price amount to make it a whole number.
   For example, Rs.12.34 has a value 1234 where 100 is the offset value.

"subtotal": {
"value": 12.34,
"offset": 100
}

Yes

tax

Object

The tax information for this order which contains the following fields:

1. offset: integer
   Required. Must be 100 for INR
2. value: integer
   Required. Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234
   3)description: string
   Optional. Max character limit is 60 characters.

"tax": {
"value": 00,
"offset": 100,
"description": "0%"
}

Yes

shipping

Object

The shipping cost of the order. The object contains the following fields:
1)offset: integer
Required. Must be 100 for INR
2)value: integer
Required. Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234
3)description: string
Optional. Max character limit is 60 characters.

"shipping": {
"value": 0,
"offset": 100,
"description": "0% off on your order"
}

No

discount

Object

The discount for the order. The object contains the following fields:
1)offset: integer
Required. Must be 100 for INR
2)value: integer
Required. Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234
3)description: string
Optional. Max character limit is 60 characters
4)discount_program_name: string
Optional. Text used for defining the orders with incentive. If an order is incentivized, the merchant needs to define this information. Max character limit is 60 characters.

"discount": {
"value": 0,
"offset": 100,
"description": "0% discount",
"discount_program_name": "optional_text"
}

No

catalog_id

Object

The unique identifier of the Facebook catalog being used by the business.
If you do not provide this field, make sure you provide the following fields inside the items object:
country_of_origin, importer_name, and importer_address.

the-catalog_id

No

expiration

Object

The expiration time for that order. Business must define the following fields inside this object:

1. timestamp: string – UNIX timestamp, after which the order expires.
   The minimum validity interval is 300 seconds.
   The specified time interval is calculated from the time the order message is delivered.

2. description: string – Text explanation for expiration. Max character limit is 120 characters.

"expiration":
{"timestamp": "1721198395 ",
"description": "cancellation-explanation"

No

link

String

A link to the item image that is shown to the end customer.
Must be an image/jpeg or image/png and 8-bit, RGB or RGBA. Follows same requirements as image in media.

@/C:/Users/company_A/Downloads/videoplayback.mp4

Yes

sid

String

Account SID (Security identifier)

HXXXXXXX071US

Yes

api_key

String

The API key generated by kaleyra.io

Ac4XXXXX21f

Yes

to_number

String

A valid WhatsApp number of the recipient. Ensure that the country code is prefixed to the number. (E164 format).
Note: You can add multiple numbers, separate each number using the comma (,).

xx988xxx70xx

Yes

type

String

Message format for the message. The type must be 'order_details'.

order_status

Yes

from_number

String

The number registered with WhatsApp business from which the message is to be sent. Ensure that the country code is prefixed to the number. (E164 format).

xx80452xxxxx

Yes

body

String

Message body

Hello User

Yes

footer

String

An object with the footer of the message. The object contains the following fields:
text string.
Required if footer is present. The footer content. Emojis, markdown, and links are supported. Maximum length is 60 characters.

Footer text

No

reference_id

String

The ID sent by the business in the order_details message

Hello_2hyabfabkeabzahi

Yes

order

Object

This object contains the following fields:

1. status: string
   Required. The represents the new order status.
   The status values can be:
   processing, partially_shipped, shipped, completed, canceled.
2. description: string
   Optional. This is the text that shows the status related information in the order_details.
   This is useful while sending cancellation.
   Maximum character limit is 120 characters.

"order": {
"status": "partially_shipped",
"description": "Order status update"

Yes

action

Object

An action object you want the user to perform after reading the message. This action object contains the following fields:

1. name:string
   Required. Must be "review_and_pay".

2. parameters object
   See, [Parameters_object_description][Parameters_object_description](Parameters description table) table for information.

'action="
{

"name": "review_order",

` "parameters": {

`"reference_id": "Hello_2hyabfabkeabzahi",

"order": {

"status": "partially_shipped",

"description": "Order status update" }}

Yes

Callback_
profile_id

String

The callback ID created for WhatsApp channel to receive updates about the message delivery status.

Note: You can also use callback_url to get updates about the message delivery status to the specified URL.

xx_b86b078e-046b-4565-892c-XXXXXXXXXXXX

No

sid

String

Account SID (Security Identifier).

HXXXXXXX071US

Yes

api_key

String

The API Key generated by kaleyra.io.

Ac4XXXXX21f

Yes

reference_id

String

Unique ID given by the business for every transaction.

It is case sensitive and cannot be an empty string. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters.

If there is a need to send multiple order_details messages for the same order, add a sequence number in the reference_id (for example, "BM345A-12") to ensure reference_id uniqueness.

Hello_2abcdxyabxyaab

Speed

String

The time at which the refund should be done.
For Instant speed, the refund is done immediately.
For normal speed, the refund may be done with a time delay.

Instant, Normal

Yes

Payment_
config_id

String

The name of the pre-configured payment configuration to use for this order and must not exceed 60 characters. This value must match with a payment configuration set up on the WhatsApp Business Manager
Note: When the configuration_name is invalid, the customer will be unable to pay for their order.

xxxxxo_2abcdxyabxyaab

Yes

currency

String

Name of the currency used in the payment transaction.

INR

Yes

value

Integer

The refund amount to be paid to the customer.

100

Yes

offset

Integer

The offset value is to be calibrated with the currency value.

100

Yes

number

Integer

The customer number to which the refund has to be made.

xx99xxx17xx6

Yes