Skip to navigation
PaymentsPayment Gateways

Trigger a pre-debit notification

View as Markdown

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 Implement UPI on Adyen Integration v2.0 for more information.

Before using this operation, ensure the following prerequisites are met:

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional<=255 characters
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-EncodingstringOptional

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-EncodingstringOptional

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-IdstringOptional<=64 characters

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-IdsstringOptional

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-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org 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-VersionstringOptional

The minor API version.

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

Request

This endpoint expects an object.
invoiceKeystringRequired

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

paymentGatewayIdstringOptional

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.

paymentMethodIdstringOptional

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 headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

OK
successbooleanOptional
Indicates whether the call succeeded.
invoiceIdstringOptional

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

paymentMethodIdstringOptional
The ID of the associated payment method.
gatewayIdstringOptional
The ID of the associated payment gateway.
gatewayTypestringOptional
The gateway type used in this operation.
gatewayVersionstringOptional
The version number of the gateway used.
notificationReferenceIdstringOptional

The value of the shopperNotificationReference field returned from the gateway.

secondNotificationReferenceIdstring or nullOptional
The additional second reference ID returned from the gateway.
thirdNotificationReferenceIdstring or nullOptional
The additional third reference ID returned from the gateway.
extraParametersstring or nullOptional
The extra optional parameter returned from the gateway.

Errors

4XX
Client Request Error
500
Internal Server Error