SearchThe notify() method is used to send the subscription notification, by passing the below parameters in the builder: PgPaymentRequest.build_subscription_notify_request()
Parameters
| Attribute | Data Type | Mandatory | Description | Default Value |
|---|---|---|---|---|
merchant_order_id | Str | Yes | Unique order ID generated by merchant | |
| Str | Yes | Unique subscription ID generated by merchant | |
amount | Int | Yes | Amount of order in Paisa 1. FULL auth – first debit amount 2 . PENNY auth – 200 | |
order_expire_at | Int | No | Order expireAt epoch after which order will auto fail if not terminal | 48 hours |
| RedemptionRetryStrategy | No | Redemption retry strategy in case attempts fail 1. STANDARD – Internal Retries 2. CUSTOM – Merchant needs to retry | STANDARD |
auto_debit | Bool | No | Auto debit redemption 24 hours after notify success Can’t be true for CUSTOM redemptionRetryStrategy | false |
meta_info | MetaInfo | No | User defines fields propagated in status check & callbacks |
Example:
import uuid
from phonepe.sdk.pg.common.models.request.pg_payment_request import PgPaymentRequest
from phonepe.sdk.pg.subscription.v2.subscription_client import SubscriptionClient
from phonepe.sdk.pg.subscription.v2.models.request.redemption_retry_strategy import RedemptionRetryStrategy
client_id = "<cliend_id>"
client_secret = "<client_secret>"
client_version = 1
env = Env.SANDBOX
subscription_client = SubscriptionClient.get_instance(client_id, client_secret, client_version, env)
merchant_order_id = str(uuid.uuid4())
merchant_subscription_id = "<MERCHANT_SUBSCRIPTION_ID>"
redemption_retry_strategy = RedemptionRetryStrategy.STANDARD
auto_debit = False
amount = 100
notify_request = PgPaymentRequest.build_subscription_notify_request(
merchant_order_id=merchant_order_id,
merchant_subscription_id=merchant_subscription_id,
auto_debit=auto_debit,
redemption_retry_strategy=redemption_retry_strategy,
amount=amount
)
notify_response = subscription_client.notify(notify_request)
state = notify_response.state #state will be NOTIFICATION_IN_PROGRESSReturns:
The function returns a PgPaymentResponse object with the following properties:
PgPaymentResponse Properties:
Here is the response property table for the given model:
| Property | Type | Description |
|---|---|---|
order_id | String | Unique order ID generated by PhonePe |
state | String | State of the order notified. It will be NOTIFICATION_IN_PROGRESS |
expire_at | Long | Order expire date in epoch |