Sign in
Payment Gateways

Trigger a 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.
post/v1/payment-gateways/pre-debit-notification

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

invoiceKeystring required

The unique identifier for an invoice. It can be either a UUID
such as 2c92c8955bd63cc1015bd7c151af0000, or an invoice number
such as INV-0000001.

paymentGatewayIdstring

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.

paymentMethodIdstring

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.

Example request

{
  "invoiceKey": "c2289d0a8d3af0f2018d3b2b1fd00000",
  "paymentGatewayId": "80289d0a8d3af0f2018d3b1b8b800000",
  "paymentMethodId": "40289d0a8d3af0f2018d3b2b1fd00000"
}

Response

OK

successboolean

Indicates whether the call succeeded.

invoiceIdstring

The ID of the invoice, for which the pre-debit notification is triggered.

paymentMethodIdstring

The ID of the associated payment method.

gatewayIdstring

The ID of the associated payment gateway.

gatewayTypestring

The gateway type used in this operation.

gatewayVersionstring

The version number of the gateway used.

notificationReferenceIdstring

The value of the shopperNotificationReference field returned from the gateway.

secondNotificationReferenceIdstring nullable

The additional second reference ID returned from the gateway.

thirdNotificationReferenceIdstring nullable

The additional third reference ID returned from the gateway.

extraParametersstring nullable

The extra optional parameter returned from the gateway.

Example response

{
  "success": true,
  "invoiceId": "c2289d0a8d3af0f2018d3b2b1fd00000",
  "paymentMethodId": "40289d0a8d3af0f2018d3b2b1fd00000",
  "gatewayId": "80289d0a8d3af0f2018d3b1b8b800000",
  "gatewayType": "Adyen",
  "gatewayVersion": "2",
  "notificationReferenceId": "40289d0a8d3af0f2018d3b2b1fd00000",
  "secondNotificationReferenceId": null,
  "thirdNotificationReferenceId": null,
  "extraParameters": null
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.