List Mandate
This api will be used for getting a list of mandates.
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 upiListMandate for this call.
Example:- upiListMandate
Maximum number of rows to be returned.
Example:- eg. 100
Offset for mandates to be returned.
Example:- 0
Type of mandates to be returned.
Example:- Possible values :- PENDING | ONGOING | COMPLETED | PAUSED | INACTIVE
Key ID to identify the public-private key pair used for signature generation.
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
Example:- stock
Any unique reference associated with your customer.
Time when request is created in milliseconds.
Signature generated for the signaturePayload .
Stringified json for udf parameters
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Response Parameters
Operation performed on SDK.
Example:- upiListMandate
Status for transaction
PSP response code for the API
PSP response message for the API
JSON containing all mandate relevant data
reference id for selected accounts
Transaction Amount. Numeric String with two decimals
Example:- eg. 25.00
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.
Complaint reference id
Example:- eg. 465738
Response code returned by NPCI for the transaction
Example:- Any valid NPCI error code
Response message returned by NPCI for the transaction.
Example:- Your Complaint is Raised successfully
Response status returned by gateway}
Example:- Value: OPEN | PENDING | CLOSED | FAILURE
Name of the mandate, Helps with differentiation of all mandates
Payee Vpa
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
Any mandate summary. If passed 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
Example:- UPI_MANDATE
Date before which mandate can be executed
Date after which mandate can be executed.
As passed in request
Possible values :- true/false
Error Message
Error Code
Value: process_result