Notification API

Notification API is required for merchants to notify users. Sends a notification to the customer before the mandate transaction is exercised. A notification has to be sent to the user 24 hours before the execution of the mandate. This API is called using the mandate_id generated while creation of mandate.

📘

Note:

Length upto 25 and alphanumberic characters are only accepted.

Response Parameters:

Parameter

Type

Description

id

String

Unique identifier provided by Juspay

source_object

String

Source object for notification. i.e. “Mandate”

object_reference_id

String

Unique Identifier passed in the request.
I.e. 1234578

provider_name

String

Name of the provider. Gateway name in this case
I.e. PAYTM_V2

notification_type

String

Type of notification.
I.e. “SMS”

source_info

Json

Json block of source info provided in the request

provider_response

Json

Json block of response from gateway

description

String

Reason for debit passed in the request

status

String

Status of Notification
CREATED/PENDING/SUCCESS/FAILURE
CREATED- Created and not yet initiated to gateway
PENDING- Initiated to gateway
SUCCESS- Success from gateway
FAILURE- Failed from gateway

date_created

String

Date-time of notification created in UNIX EPOCH timestamp (UTC timezone) format

last_updated

String

Date-time of notification updated in UNIX EPOCH timestamp (UTC timezone) format

metadata

String

Metadata passed in the request

Mandate JSON block:

Parameter

Type

Description

mandate_id

String

Mandate id provided in the request

Source_info JSON block:

Parameter

Type

Description

amount

String

Amount passed in the request
I.e. 100.00

txn_date

String

Txn_date passed in the request YYYY-MM-DD HH:MM
I.e. 2020-07-15 15:00

mandate.display_invoice_number

String

The display invoice number that is passed in the request.

Provider_response JSON block:

Parameter

Type

Description

provider_ref_id

String

Reference Number provided by downstream gateway

notificationDate

String

Date on which notification has been sent. Specific to PAYTM_V2
YYYY-MM-DD HH:MM
I.e. 2020-07-15 15:00

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!