# Get UPI Mandate

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/upi-mandate/{referenceId}:
    get:
      summary: Get UPI Mandate
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to retrieve the details of a specific UPI mandate by its
        ID. This helps you check the status, amount, frequency, and other
        mandate information for easier tracking and customer support.

        :::
      tags:
        - Payment Gateway/APIs - Payment Gateway /UPI Autopay
      parameters:
        - name: referenceId
          in: path
          description: ''
          required: true
          schema:
            type: string
        - name: merchantAccessKey
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  umn:
                    type: string
                  referenceId:
                    type: string
                  amount:
                    type: integer
                  amountRule:
                    type: string
                  currency:
                    type: string
                  payer:
                    type: object
                    properties:
                      name:
                        type: string
                      vpa:
                        type: string
                      account:
                        type: string
                      accountValidation:
                        type: boolean
                    required:
                      - name
                      - vpa
                      - account
                      - accountValidation
                    x-apidog-orders:
                      - name
                      - vpa
                      - account
                      - accountValidation
                  name:
                    type: string
                  blockFund:
                    type: boolean
                  revokeableByPayer:
                    type: boolean
                  recurrence:
                    type: object
                    properties:
                      period:
                        type: string
                      rule:
                        type: string
                      value:
                        type: integer
                    required:
                      - period
                      - rule
                      - value
                    x-apidog-orders:
                      - period
                      - rule
                      - value
                  validity:
                    type: object
                    properties:
                      startAt:
                        type: string
                        format: date-time
                      endAt:
                        type: string
                        format: date-time
                    required:
                      - startAt
                      - endAt
                    x-apidog-orders:
                      - startAt
                      - endAt
                  pausePeriod:
                    type: object
                    properties:
                      startAt:
                        type: string
                        format: date-time
                      endAt:
                        type: string
                        format: date-time
                    required:
                      - startAt
                      - endAt
                    x-apidog-orders:
                      - startAt
                      - endAt
                  upiReferenceUrl:
                    type: string
                  description:
                    type: string
                  upiPurposeCode:
                    type: string
                  upiResponseCode:
                    type: string
                  status:
                    type: string
                  mandateId:
                    type: string
                  expiry:
                    type: string
                    format: date-time
                  createdOn:
                    type: string
                    format: date-time
                required:
                  - umn
                  - referenceId
                  - mandateId
                  - amount
                  - amountRule
                  - currency
                  - payer
                  - name
                  - expiry
                  - blockFund
                  - revokeableByPayer
                  - recurrence
                  - upiReferenceUrl
                  - description
                  - upiPurposeCode
                  - upiResponseCode
                  - status
                  - createdOn
                  - validity
                x-apidog-orders:
                  - umn
                  - referenceId
                  - mandateId
                  - amount
                  - amountRule
                  - currency
                  - payer
                  - name
                  - expiry
                  - blockFund
                  - revokeableByPayer
                  - recurrence
                  - validity
                  - pausePeriod
                  - upiReferenceUrl
                  - description
                  - upiPurposeCode
                  - upiResponseCode
                  - status
                  - createdOn
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /UPI Autopay
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-13730812-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```