# SMS

As a PesaWay merchant, you can send messages (both transactional and promotional) to your customers / employees through various networks. The SMS API is applicable in various use cases such as payment feedback, news updates, advertisements, etc

Alt test Endpoint: https://api.sandbox.pesaway.com/api/v1/sms/send-bulk-sms/

# Send SMS

# Supported Networks

Country	Network
Kenya	Safaricom, Airtel, Telkom

# Request Parameters

Field	Type	Description	Examples
message	String	The message that's to be sent out.	"Luke, I am your father."
destination	List or String	Phone number (s) you would want the message delivered to.	"254700000000" or ["254700xxx000", "254711xxx111]

# Sample Request

curl --location --request POST 'https://api.sandbox.pesaway.com/api/v1/sms/send-bulk-sms/' \
--header 'Authorization: Bearer MWU1NzI1YzhhN2Y1YTExMmU5ZWI4NGNlMDdjODc5' \
--header 'Content-Type: application/json' \
--header 'X-Region: ke' \
--data-raw '{
    "message": "Luke, I am your father.",
    "destination": "25471\*\*\*\***8",
}'

# Response Parameters

Field	Type	Description	Example
code	String	This is a status code for either success or failure of the transaction	"200.001"

# Response Sample

{
  "code": "200.001"
}

# SMS Balance

# Request Parameters

Field	Type	Description	Examples

# Sample Request

curl --location --request POST 'https://api.sandbox.pesaway.com/api/v1/sms/account-balance/' \
--header 'Authorization: Bearer MWU1NzI1YzhhN2Y1YTExMmU5ZWI4NGNlMDdjODc5' \
--header 'Content-Type: application/json' \
--header 'X-Region: ke' \
--data-raw '{}'

# Response Parameters

Field	Type	Description	Example
code	String	This is a status code for either success or failure of the transaction	"200.001"
data	Dict	This is the response dictionary with balance data	{"balance": "2000"}

# Response Sample

{
  "code": "200.001",
  "data": {
    "balance": "2000"
  }
}

TIP

Alway include the X-Region header on all requests. The right X-Region can be found on the Supported Regions / Countries menu

← Account Balance