Revoke Active Mandates
Since the merchantCustomer is inactive, any execution or update will fail with QS (PAYER PROFILE DOES NOT EXIST).
Notify merchant with
MANDATE_STATUS_UPDATEcallback.
Scroll inside to view more
|
parameter
|
description
|
|---|---|
amount
| Amount of Mandate. Numeric string with two decimals.
|
amountRule
| Rule on Mandate Amount. If amountRule is MAX, then mandate can be executed for amount less than or equal to the passed amount. If amountRule is EXACT, then mandate should always be executed for the same amount.
|
gatewayMandateId
| Refers to the upiRequestId used during creation of the mandate.
|
gatewayResponseMessage
| Response message returned by the gateway for the mandate.
|
initiatedBy
| Describes whether PAYER or PAYEE initiated the mandate.
|
mandateName
| Name of the mandate as provided by the initiator.
|
merchantChannelId
| Unique ID for the channel via which the mandate request is made.
|
merchantCustomerId
| Merchant-generated unique ID for the customer.
|
merchantId
| Unique identifier for the merchant.
|
orgMandateId
| Refers to the original upiRequestId used during creation of the mandate.
|
payeeVpa
| Virtual Payment Address (VPA) of the payee involved in the mandate.
|
payerRevocable
| Indicates whether the mandate can be revoked by the payer. If set to true, the payer can revoke the mandate. Default is true for recurring mandates.
|
payerVpa
| Virtual Payment Address (VPA) of the payer involved in the mandate.
|
purpose
| Purpose code associated with the mandate, indicating the reason for the transaction.
|
recurrencePattern
| Recurrence pattern for the mandate. Possible values include ONETIME, DAILY, WEEKLY, etc.
|
role
| Role of the customer in the mandate. Either PAYER or PAYEE.
|
shareToPayee
| Indicates whether the mandate should be shared with the payee. Default is true.
|
status
| Current status of the mandate. Possible values include ACTIVE, DORMANT, EXPIRED, etc.
|
transactionType
| Type of transaction. For mandate creation and updates, this will be UPI_MANDATE.
|
type
| Callback event type. For status updates, this will be MANDATE_STATUS_UPDATE.
|
umn
| VPA used for execution of the mandate.
|
validityEnd
| Date until which the mandate can be executed.
|
validityStart
| Date after which the mandate can be executed.
|