Send Notifications

Send notifications to your customers via SMS and Email using this endpoint.

POST /v1/invoices/:id/notify_by/:medium

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/invoices/inv_DAuFuwWYU3R9tg/notify_by/sms \

Success

{
    "success": true
}

Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States

Use this endpoint to send notifications with the short URL to the customer via email or SMS.

Curl

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/invoices/inv_DAuFuwWYU3R9tg/notify_by/sms \

Success

{
    "success": true
}

Path Parameters

id · string · required

The unique identifier of the invoice whose link is to be sent by SMS or email.

medium · string · required

Possible values:

• sms
• email

Response Parameters

success · boolean

Indicates whether the notifications were sent successfully. Possible values:

• true: The notifications were successfully via SMS, email or both.
• false: The notifications were not sent.

Errors

The API `<key/secret> ` provided is invalid.

Code: 4xx

There is a mismatch between the API credentials passed in the API call and those generated on the Dashboard.

Solution:

• Ensure that the API Keys are active and entered correctly.
• There should be no whitespaces before or after the keys.

The id provided does not exist.

Code: 400

The invoice id entered is either invalid or does not belong to the requester account.

Solution: Enter a valid invoice id.

{medium} is not a valid communication medium.

Code: 400

The medium path parameter is not sms or email. The error echoes the actual invalid medium value.

Solution: Use either sms or email as the medium path parameter.

Email can not be sent since email address has not been provided.

Code: 400

The notification request used medium=email but the invoice does not have a customer email address on file.

Solution: Update the invoice to include customer.email, or send the notification via medium=sms if a contact number is available.

SMS can not be sent since contact number has not been provided.

Code: 400

The notification request used medium=sms but the invoice does not have a customer contact number on file.

Solution: Update the invoice to include customer.contact, or send the notification via medium=email if an email address is available.

Operation not allowed for Invoice in {draft|paid|expired|cancelled} status.

Code: 400

Notifications can only be sent for invoices in the issued or partially_paid state. The error message echoes the invoice’s actual current status. For example, Operation not allowed for Invoice in cancelled status.

Solution: Issue the invoice first (or wait for it to move to partially_paid) before sending notifications.