Introduction

API Reference Guide

API Changelog

Understand Razorpay APIs

Authentication

Sandbox Setup

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Subscriptions

Route

Smart Collect

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates

Complaints

UPI Number

UPI Lite

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Fetch Balance

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Invoices

Resend

API Test Keys

Send Notifications

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

Click to copy

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

Is this page helpful?

Curl

change language

change language

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

Success

Failure

1
{
2
    "success": true
3
}
Path Parameters
id

*

string

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

medium

*

string

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.

Error Status: 4xx

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

Solution

The id provided does not exist.

Error Status: 400

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

Solution

email is not a valid communication medium.

Error Status: 400

There is a spelling error in “email” in the URL.

Solution

Send Notifications

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

Click to copy

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

Is this page helpful?

Path Parameters
id

*

string

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

medium

*

string

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.

Error Status: 4xx

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

Solution

The id provided does not exist.

Error Status: 400

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

Solution

email is not a valid communication medium.

Error Status: 400

There is a spelling error in “email” in the URL.

Solution

Curl

change language

change language

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

Success

Failure

1
{
2
    "success": true
3
}