---
title: "Trigger a pre-debit notification"
method: POST
path: "/v1/payment-gateways/pre-debit-notification"
tags: ["Payment Gateways"]
---

# Trigger a pre-debit notification

`POST /v1/payment-gateways/pre-debit-notification`

To support processing recurring UPI payments through Adyen Integration v2.0, 
a pre-debit notification for each posted invoice must be sent to the UPI users 
before collecting the recurring payments. Use this operation to send pre-debit notification requests 
to the gateway for invoices that meet the requirements. 
See <a href="https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/adyen-payment-gateway/implement-upi-on-adyen-integration-v2.0" target="_blank">Implement UPI on Adyen Integration v2.0</a> for more information.

Before using this operation, ensure the following prerequisites are met:
  - <a href="https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/adyen-payment-gateway/implement-upi-on-adyen-integration-v2.0" target="_blank">Support for UPI transactions on Adyen</a> has been enabled. This is a feature that can be requested through the Specialized Payment Connections service at an additional cost.
  - Ensure the <a href="https://docs.zuora.com/en/zuora-payments/manage-payment-gateway-integrations-and-payment-methods/set-up-payment-gateway-integrations/adyen-payment-gateway/implement-upi-on-adyen-integration-v2.0" target="_blank">conditions for triggering pre-debit notification requests</a> are met.

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- PostTriggerPreDebitNotificationRequest
  - `invoiceKey` string, required — The unique identifier for an invoice. It can be either a UUID such as `2c92c8955bd63cc1015bd7c151af0000`, or an invoice number such as `INV-0000001`.
  - `paymentGatewayId` string — The ID of the payment gateway used to process the payment, such as `8ad08aef83d0c3000183d4b5a2d51933`. If it is not provided, the ID of the default payment gateway is used.
  - `paymentMethodId` string — The ID of the payment method used for the payment, such as `4ad08aef83d0c30102183d4b5a2d51733`. If it is not provided, the ID of the default payment method is used.

## Response `200`

OK

- PostTriggerPreDebitNotificationResponse
  - `success` boolean — Indicates whether the call succeeded.
  - `invoiceId` string — The ID of the invoice, for which the pre-debit notification is triggered.
  - `paymentMethodId` string — The ID of the associated payment method.
  - `gatewayId` string — The ID of the associated payment gateway.
  - `gatewayType` string — The gateway type used in this operation.
  - `gatewayVersion` string — The version number of the gateway used.
  - `notificationReferenceId` string — The value of the `shopperNotificationReference` field returned from the gateway.
  - `secondNotificationReferenceId` string, nullable — The additional second reference ID returned from the gateway.
  - `thirdNotificationReferenceId` string, nullable — The additional third reference ID returned from the gateway.
  - `extraParameters` string, nullable — The extra optional parameter returned from the gateway.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)