Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Create Pre-Debit Notification

Sends the NPCI-required pre-debit notification to the customer before a UPI Autopay recurring debit. The provider delivers the notice and returns a reference; keep the returned id and send it on the recurring debit as payment_method.detail.bank_transfer.pre_debit_notification_id.

post/predebit-notify

Headers

X-Idempotency-Keystring required

Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts.

Request body

account_idstring uuid required

Your Yuno account ID.

merchant_referencestring required

Your unique reference for this notification. Reusing a reference returns the existing notification (idempotent per account).

descriptionstring

Text shown to the customer in the notification (for example, the subscription name and renewal notice).

billing_datestring date required

Date of the upcoming debit (YYYY-MM-DD). Per NPCI, notify the customer at least 24 hours before the debit.

billing_sequence_numberstring

Sequence number of the debit within the mandate (for example, 2 for the second charge).

origin_payment_idstring uuid

ID of the mandate-creation payment. When provided, Yuno derives the provider and connection from its successful charge. Either origin_payment_id or provider_data is required.

Example request

{
  "amount": {
    "currency": "INR",
    "value": "499.00"
  },
  "payment_method": {
    "type": "UPI_AUTOPAY"
  },
  "provider_data": {
    "id": "EBANX"
  }
}

Response

Notification created. Check status: SENT means the provider delivered it.

idstring uuid

Unique identifier of the pre-debit notification. Reference it on the recurring debit as payment_method.detail.bank_transfer.pre_debit_notification_id.

account_idstring uuid

Your Yuno account ID.

status'SENT' | 'REJECTED' | 'ERROR'

SENT: the provider accepted and delivered the notification. REJECTED: the provider refused it. ERROR: the notification could not be relayed.

merchant_referencestring

Your unique reference for this notification (idempotent per account).

descriptionstring

Text shown to the customer in the notification.

billing_datestring date

Date of the upcoming debit (YYYY-MM-DD).

origin_payment_idstring uuid

The mandate-creation payment used to derive provider and connection, when provided.

created_atstring date-time
updated_atstring date-time

Example response

{
  "amount": {
    "currency": "INR",
    "value": "499.00"
  }
}