---
page_source: https://docs.juspay.io/upi-inapp/android/headless-process-payloads/list-mandate
page_title: List Mandate
---


## List Mandate



This api will be used for getting a list of mandates.


###   Process Parameters



## Request Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String, Mandatory
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String, Mandatory
- **Payload**:
  - Description: Parameters required to call Hyper SDK API
  - Value:
    - **Action**:
      - Description: Operation to be performed in the SDK. Should be upiListMandate for this call.
      - Value: upiListMandate
      - Tags: String, Mandatory
    - **Limit**:
      - Description: Maximum number of rows to be returned.
      - Value: eg. 100
      - Tags: String, Mandatory
    - **Offset**:
      - Description: Offset for mandates to be returned.
      - Value: 0
      - Tags: String, Mandatory
    - **Status**:
      - Description: Type of mandates to be returned.
      - Value: Possible values :- PENDING | ONGOING |  COMPLETED | PAUSED | INACTIVE
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Tags: String, Mandatory
    - **SignaturePayload**:
      - Description: Signature payload is a stringified JSON of the details mentioned in the below table.
      - Value:
        - **Merchant_id**:
          - Description: Unique identifier associated with an account created by juspay. Ex: stock
          - Value: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Tags: String, Mandatory
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload .
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified json for udf parameters
      - Tags: String, Optional
  - Tags: JSON, Mandatory


## Response Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String
- **Payload**:
  - Description: Response Parameters
  - Value:
    - **Action**:
      - Description: Operation performed on SDK.
      - Value: upiListMandate
      - Tags: String, Mandatory
    - **Status**:
      - Description: Status for transaction
      - Tags: String, Mandatory
    - **ResponseCode**:
      - Description: PSP response code for the API
      - Tags: String, Mandatory
    - **ResponseMessage**:
      - Description: PSP response message for the API
      - Tags: String, Mandatory
    - **MandateList**:
      - Description: JSON containing all mandate relevant data
      - Value:
        - **AccountReferenceId**:
          - Description: reference id for selected accounts
          - Tags: String, Optional
        - **Amount**:
          - Description: Transaction Amount. Numeric String with two decimals
          - Value: eg. 25.00
          - Tags: String, Mandatory
        - **AmountRule**:
          - Tags: String, Mandatory
        - **BankAccountUniqueId**:
          - Description: Unique Identifier for bank account across banks
          - Tags: String, Optional
        - **BlockFund**:
          - Description: 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.
          - Tags: String, Mandatory
        - **Expiry**:
          - Tags: String, Optional
        - **GatewayMandateId**:
          - Tags: String, Mandatory
        - **GatewayReferenceId**:
          - Description: Complaint reference id
          - Value: eg. 465738
          - Tags: String, Optional
        - **GatewayResponseCode**:
          - Description: Response code returned by NPCI for the transaction
          - Value: Any valid NPCI error code
          - Tags: String, Mandatory
        - **GatewayResponseMessage**:
          - Description: Response message returned by NPCI for the transaction.
          - Value: Your Complaint is Raised successfully
          - Tags: String, Mandatory
        - **GatewayResponseStatus**:
          - Description: Response status returned by gateway}
          - Value: Value: OPEN | PENDING | CLOSED | FAILURE
          - Tags: String, Mandatory
        - **InitiatedBy**:
          - Tags: String, Mandatory
        - **IsMarkedSpam**:
          - Tags: String, Optional
        - **IsVerifiedPayee**:
          - Tags: String, Optional
        - **MandateApprovalTimeStamp**:
          - Tags: String, Optional
        - **MandateName**:
          - Description: Name of the mandate, Helps with differentiation of all mandates
          - Tags: String, Optional
        - **MandateTimestamp**:
          - Tags: String, Mandatory
        - **MandateType**:
          - Tags: String, Mandatory
        - **MerchantRequestId**:
          - Tags: String, Optional
        - **OrgMandateId**:
          - Tags: String, Mandatory
        - **PayeeMcc**:
          - Tags: String, Mandatory
        - **PayeeName**:
          - Tags: String, Optional
        - **PayeeVpa**:
          - Description: Payee Vpa
          - Tags: String, Mandatory
        - **PayerName**:
          - Tags: String, Optional
        - **PayerRevocable**:
          - Description: Defines whether mandate is revocable by PAYER or not. For onetime mandate it can be true or false. Default value is true.
          - Value: true/false
          - Tags: String, Mandatory
        - **PayerVpa**:
          - Tags: String, Mandatory
        - **RecurrencePattern**:
          - Description: Recurrence Pattern for Mandate
          - Tags: String, Mandatory
        - **RecurrenceRule**:
          - Description: Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
          - Tags: String, Optional
        - **RecurrenceValue**:
          - Description: Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
          - Tags: String, Optional
        - **RefUrl**:
          - Description: Reference url for the mandate
          - Tags: String, Mandatory
        - **Remarks**:
          - Description: Any mandate summary. If passed in request, it will be same in response else a default value is send
          - Tags: String, Mandatory
        - **Role**:
          - Description: Role of the customer for this mandate.
          - Value: PAYER / PAYEE
          - Tags: String, Mandatory
        - **ShareToPayee**:
          - Description: Describes whether the mandate will be shared with the payee or not. Default value is true.
          - Value: true/false
          - Tags: String, Mandatory
        - **TransactionType**:
          - Description: Type of Mandate Creation
          - Value: UPI_MANDATE
          - Tags: String, Mandatory
        - **Umn**:
          - Tags: String, Optional
        - **ValidityEnd**:
          - Description: Date before which mandate can be executed
          - Tags: String, Mandatory
        - **ValidityStart**:
          - Description: Date after which mandate can be executed.
          - Tags: String, Mandatory
        - **PauseEnd**:
          - Tags: String, Optional
        - **PauseStart**:
          - Tags: String, Optional
        - **NextExecutionDateStart**:
          - Tags: String, Optional
        - **NextExecutionDateEnd**:
          - Tags: String, Optional
      - Tags: Array of JSON, Mandatory
    - **OtherInfo**:
      - Description: As passed in request
      - Tags: String, Optional
  - Tags: JSON
- **Error**:
  - Description: Possible values :- true/false
  - Tags: Boolean
- **ErrorMessage**:
  - Description: Error Message
  - Tags: String
- **ErrorCode**:
  - Description: Error Code
  - Tags: String
- **Event**:
  - Description: Value: process_result
  - Tags: String





#### Code Snippets: -

#### Java Code Snippet:

```java
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<signaturePayload>",
    "signature": "GFe…………………..w==\n",
    "merchantKeyId": "1234",
    "status": "PENDING",
    "limit": "100",
    "offset": "0",
    "action": "upiListMandate"
  }
}

"signaturePayload": {
  "merchant_id": "XXXXXXXX",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639167811935"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<signaturePayload>",
    "signature": "GFe…………………..w==\n",
    "merchantKeyId": "1234",
    "status": "PENDING",
    "limit": "100",
    "offset": "0",
    "action": "upiListMandate"
  }
}

"signaturePayload": {
  "merchant_id": "XXXXXXXX",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639167811935"
}
```


## Sample Code Snippets:
### Request snippets:

#### Request Code Snippet:

```request
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<signaturePayload>",
    "signature": "GFe…………………..w==\n",
    "merchantKeyId": "1234",
    "status": "PENDING",
    "limit": "100",
    "offset": "0",
    "action": "upiListMandate"
  }
}

"signaturePayload": {
  "merchant_id": "XXXXXXXX",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639167811935"
}
```

### Response snippets:

#### Response:
```plaintext
{
  "service": "in.juspay.hyperapi",
  "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac",
  "payload": {
    "status": "SUCCESS",
    "responseMessage": "SUCCESS",
    "responseCode": "SUCCESS",
    "otherInfo": "{}",
    "mandateList": [
      {
        < Mandate Payload >
      },
      {
        < Mandate Payload >
      }
      ...
    ],
    "action": "upiListMandate",
    "refUrl": "https://www.abcxyz.com/"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}
```