Retrieve Pre-Debit Notification by Merchant Reference

Retrieves a pre-debit notification by the merchant reference used to create it.

get/predebit-notify

Request

Base URL
https://api-sandbox.y.uno/v1
Auth
API key in header PUBLIC-API-KEY and API key in header PRIVATE-SECRET-KEY
TypeScript
https://skmtc.dev/y/apis/ai-caller/docs/predebit-notify/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

merchant_referencestring required

The merchant_reference used on creation.

Headers

X-account-codestring uuid required

UUID of the account the notification belongs to.

Response

The pre-debit notification.

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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.