> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send Pre-Debit Notification

> Tell the buyer about an upcoming subscription debit. Required before every PayU and EximPe charge.



## OpenAPI

````yaml openapi/v3-subscriptions.json POST /pg/subscriptions/{subscription_id}/pre_debit_notification/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API - V3 Subscriptions
  description: >-
    Subscription creation and mandate management on the v3 API. Every call
    carries X-API-Version: 3.0.0.
  license:
    name: Proprietary
  version: 3.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
paths:
  /pg/subscriptions/{subscription_id}/pre_debit_notification/:
    post:
      tags:
        - Subscriptions
      summary: Send Pre-Debit Notification
      description: >-
        Before each charge on a PayU or EximPe subscription, send this
        notification. It tells the buyer the debit date and amount. Then call
        [Trigger Recurring
        Payment](/api-reference/v3/subscriptions/recurring-payment) **on**
        `debit_date` (IST).


        Cashfree subscriptions do not use this endpoint. See [How charging works
        by payment
        partner](/integration-guide/v3/web-integration/manage-subscriptions#how-charging-works-by-payment-partner).


        **When to call**


        - **PayU:** `debit_date` must be after today (IST).

        - **EximPe:** at least 24 hours before `debit_date` starts (IST).
        Example: sent at 10:00 on 5 Nov, the earliest `debit_date` is 7 Nov.

        - More than one notification can be active, each for a different future
        date. A new one must be for a date **later** than every active one.
      operationId: v3_post_pg_subscriptions_subscription_id_pre_debit_notification_
      parameters:
        - name: subscription_id
          in: path
          required: true
          description: The subscription's ID, e.g. `SUB7989707770`.
          schema:
            type: string
        - $ref: '#/components/parameters/ApiVersion'
      requestBody:
        description: The upcoming debit's date, amount and invoice display number.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreDebitNotificationRequest'
            example:
              debit_date: '2026-12-05'
              amount: 999
              invoice_display_number: COURSE-INV-2026-12
      responses:
        '200':
          description: Pre-debit notification sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreDebitNotificationResponse'
              example:
                success: true
                message: Pre-debit notification triggered successfully
                data:
                  subscription_id: SUB7989707770
                  debit_date: '2026-12-05'
                  amount: '999.00'
                  invoice_display_number: COURSE-INV-2026-12
                  notification_sent: true
        '400':
          description: >-
            A field is invalid, the mandate is not active, or (EximPe) the
            notification is less than 24 hours before the debit date starts;
            `details.error` then names the earliest debit date you can use
            (`ERR_PAYMENT_001`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Date not in the future:
                  summary: debit_date is today or earlier
                  value:
                    success: false
                    error:
                      code: ERR_PAYMENT_001
                      message: Validation error
                      details:
                        debit_date: debit_date must be greater than today
                Card without invoice number:
                  summary: Card subscription without invoice_display_number
                  value:
                    success: false
                    error:
                      code: ERR_PAYMENT_001
                      message: Validation error
                      details:
                        invoice_display_number: >-
                          invoice_display_number is required for card
                          subscriptions
                Amount too high:
                  summary: amount above the subscription's billing_amount
                  value:
                    success: false
                    error:
                      code: ERR_PAYMENT_001
                      message: Validation error
                      details:
                        amount: >-
                          Pre-debit amount must be less than or equal to the
                          subscription billing amount
                Mandate not active:
                  summary: The mandate is not active
                  value:
                    success: false
                    error:
                      code: ERR_PAYMENT_001
                      message: Validation error
                      details:
                        error: Subscription mandate is not active
        '403':
          description: >-
            Your merchant account is suspended or closed
            (`ERR_MERCHANT_ACCOUNT_003`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            `ERR_SUBSCRIPTION_001`: the subscription does not exist or is not
            yours.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_SUBSCRIPTION_001
                  message: Subscription not found
                  details:
                    subscription_id: Subscription not found
        '409':
          description: >-
            A notification is already active for the same or a later date
            (`ERR_PAYMENT_001`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_PAYMENT_001
                  message: Validation error
                  details:
                    pre_debit: >-
                      A charge is already initiated for 2026-12-05; a new one
                      must be for a later date.
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: ERR_SERVICE_ERROR_000
                  message: Payment gateway error
                  details:
                    error: >-
                      An unexpected error occurred while sending pre-debit
                      notification
        '502':
          description: >-
            PayU refused the notification (`ERR_PAYMENT_003`), or the payment
            partner could not be reached (`ERR_GATEWAY_UNAVAILABLE`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - clientAuth: []
          clientSecretAuth: []
          merchantAuth: []
components:
  parameters:
    ApiVersion:
      name: X-API-Version
      in: header
      required: false
      description: >-
        Optional. Send `3.0.0`. It is not a credential. The response's
        `X-API-Version` header echoes the value you sent, or your account's
        default version if you send none.
      schema:
        type: string
        enum:
          - 3.0.0
        default: 3.0.0
      example: 3.0.0
  schemas:
    PreDebitNotificationRequest:
      type: object
      required:
        - debit_date
      properties:
        debit_date:
          type: string
          format: date
          description: >-
            The day you will trigger the charge (YYYY-MM-DD). Must be after
            today (IST).
        amount:
          type: number
          minimum: 0.01
          description: >-
            Up to 12 digits with 2 decimals, minimum `0.01`, at most the
            subscription's `billing_amount`. Defaults to `billing_amount`. The
            charge on `debit_date` cannot exceed it.
        invoice_display_number:
          type: string
          maxLength: 255
          description: >-
            **Required on PayU**, card and UPI: Trigger Recurring Payment must
            repeat it. Optional on EximPe; if you leave it out, one is assigned
            and returned. Use a new value for each charge, and send the same
            value to Trigger Recurring Payment.
    PreDebitNotificationResponse:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            subscription_id:
              type: string
            debit_date:
              type: string
              format: date
              description: The notified debit date (YYYY-MM-DD).
            amount:
              type: string
              description: >-
                The notified amount, as a string. The charge on `debit_date`
                cannot exceed it.
            invoice_display_number:
              type: string
              nullable: true
              description: >-
                The invoice display number for this charge. Send the same value
                to Trigger Recurring Payment.
            notification_sent:
              type: boolean
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **Client Application ID** - Your unique application identifier used to
        authenticate API requests. You can find your Client ID in the Developer
        Settings section of the merchant dashboard.
      x-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **Client Secret Key** - Your secret key used alongside the Client ID for
        secure authentication. Keep this confidential and never expose it in
        client-side code. Available in the Developer Settings section of the
        merchant dashboard.
      x-displayName: Client Secret
      x-example: your-client-secret
    merchantAuth:
      type: apiKey
      name: X-Merchant-ID
      in: header
      description: >-
        **Merchant Identifier** - The unique ID for the merchant account. This
        is required for PSP (Payment Service Provider) merchants who manage
        multiple merchant accounts. You can find merchant IDs in the Merchant
        Management section of the dashboard.
      x-displayName: Merchant ID
      x-example: your-merchant-id

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.