# Update UPI Mandate

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/upi-mandate:
    patch:
      summary: Update UPI Mandate
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to modify the details of an existing UPI mandate, such as
        updating the payment amount, frequency, or mandate expiry. This helps
        you manage changes to recurring payment agreements seamlessly.

        :::
      tags:
        - Payment Gateway/APIs - Payment Gateway /UPI Autopay
      parameters:
        - name: merchantAccessKey
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  description: '100.01'
                validity:
                  type: object
                  properties:
                    endAt:
                      type: string
                      format: date-time
                  required:
                    - endAt
                  x-apidog-orders:
                    - endAt
                description:
                  type: string
                expiry:
                  type: string
                  format: date-time
                pausePeriod:
                  type: object
                  properties:
                    startAt:
                      type: string
                      format: date-time
                    endAt:
                      type: string
                      format: date-time
                  x-apidog-orders:
                    - startAt
                    - endAt
                  required:
                    - startAt
                    - endAt
              x-apidog-orders:
                - amount
                - expiry
                - validity
                - description
                - pausePeriod
            example:
              referenceId: TMUM9876543
              amount: 2540
              expireAt: '2025-01-31 00:00:00'
              validity:
                endAt: '2025-01-30 00:00:00'
              description: Updated Mandate Request
      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
                  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
                  mcc:
                    type: string
                  createdOn:
                    type: string
                    format: date-time
                  expiry:
                    type: string
                    format: date-time
                  mandateId:
                    type: string
                required:
                  - umn
                  - referenceId
                  - mandateId
                  - amount
                  - amountRule
                  - currency
                  - mcc
                  - payer
                  - name
                  - expiry
                  - blockFund
                  - recurrence
                  - validity
                  - pausePeriod
                  - upiReferenceUrl
                  - description
                  - upiPurposeCode
                  - upiResponseCode
                  - status
                  - createdOn
                x-apidog-orders:
                  - umn
                  - referenceId
                  - mandateId
                  - amount
                  - amountRule
                  - currency
                  - mcc
                  - payer
                  - name
                  - expiry
                  - blockFund
                  - recurrence
                  - validity
                  - pausePeriod
                  - upiReferenceUrl
                  - description
                  - upiPurposeCode
                  - upiResponseCode
                  - status
                  - createdOn
              example:
                umn: XYZ987
                referenceId: TXN6543210
                mandateTransactionId: ENKA00001234
                amount: 1722
                amountRule: EXACT | MAX
                currency: usd
                payee:
                  vpa: merchant@abc
                  name: ABC Pvt. Ltd.
                  mcc: '1234'
                payer:
                  name: Jane Smith
                  vpa: 1234567890.prod@bank
                  account: '5678901234'
                  accountValidation: true
                name: Subscription Payment
                expireAt: 1823418099
                blockFund: true
                revokeableByPayer: true
                recurrence:
                  period: >-
                    ONE_TIME | DAILY | WEEKLY | FORTNIGHTLY | MONTHLY |
                    BIMONTHLY | QUARTERLY | HALF_YEARLY | YEARLY | AS_PRESENTED
                  rule: after
                  value: 3
                validity:
                  startAt: 1823418099
                  endAt: 1924519100
                pausePeriod:
                  start_at: 1722317078
                  end_at: 1722317078
                upiReferenceUrl: https://www.example.com/
                description: Automated Recurring Mandate
                upiPurposeCode: '10'
                upiResponseCode: '99'
                status: pending
                createdAt: 1823418099
          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-13730809-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```