Check Mandate Status
This api will be used for getting mandate status.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK. Should be upiCheckMandateStatus for this call.
Example:- upiCheckMandateStatus
Defines the role of the customer in the mandate PAYER / PAYEE
Key ID to identify the public-private key pair used for signature generation.
gatewayMandateId returned during create mandate
Signature generated for the signaturePayload.
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.Ex: stock
Any unique reference associated with your customer.
Time when request is created in milliseconds.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Response Parameters
Value: upiCheckMandateStatus
Example:- Operation to be performed in the SDK.
Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE
Response code returned by gateway for the mandate Operation.
Response message returned by gateway for the mandate Operation.
Contains relevant mandate data
reference id for selected accounts
Amount for which merchant requested the mandate. Numeric String with two decimals
Example:- eg. 25.00
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.
Example:- MAX / EXACT
Unique Identifier for bank account across banks
Denotes whether customer's fund should be blocked or not. Only applicable for ONETIME mandate. For recurring mandate it should always be false, for onetime it can be true or false. Default value is false.
Minutes for which request is valid
UPI request id returned by gateway for the mandate
Unique Transaction Number
Response code returned by gateway for the transaction.
Response message returned by gateway for the transaction.
Response status returned by gateway.
Who has created this update/revoke request. Possible values :- PAYER / PAYEE
Example:- Possible values :- PAYER / PAYEE
Name of the mandate, Helps with differentiation of all mandates
Timestamp of when the webMandate was initiated
Merchant generated unique profile id for customer as passed in the request
35 character alphanumeric unique id.
gatewayMandateId returned during create mandate
Defines whether mandate is revocable by PAYER or not. For onetime mandate it can be true or false. Default value is true.
Example:- true/false
Recurrence Pattern for Mandate
Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Reference url for the mandate. It will be same value if passed in request else it will be a default url.
Any mandate summary. If pased in request, it will be same in response else a default value is send.
Role of the customer for this mandate.
Example:- PAYER / PAYEE
Describes whether the mandate will be shared with the payee or not. Default value is true.
Example:- true/false
Type of Mandate Creation.
Date after which mandate can be executed
String with proper date format YYYY/MM/DD
Details for refUrl, whether it is 01 (advertisement), 02(Invoice). If nothing is passed, a default value of `00` is set up and same will be sent back in response.
Defines the purpose code of the mandate
Defines the initiationMode of the mandate
As passed in request
Possible values :- true/false
Error Message
Error Code
Value: process_result