Sign in
General

Ask issuer to notify the shopper

Sends a request to the issuer so they can inform the shopper about the upcoming recurring payment. This endpoint is used only for local acquiring in India. For more information, refer to Recurring card payments in India.

post/notifyShopper

Request body

billingDatestring

Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format

billingSequenceNumberstring

Sequence of the debit. Depends on Frequency and Billing Attempts Rule.

displayedReferencestring

Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing

merchantAccountstring required

The merchant account identifier with which you want to process the transaction.

recurringDetailReferencestring

This is the recurringDetailReference returned in the response when you created the token.

referencestring required

Pre-debit notification reference sent by the merchant. This is a mandatory field

shopperReferencestring required

The ID that uniquely identifies the shopper.

This shopperReference must be the same as the shopperReference used in the initial payment.

storedPaymentMethodIdstring

This is the recurringDetailReference returned in the response when you created the token.

Response

OK - the request has succeeded.

displayedReferencestring

Reference of Pre-debit notification that is displayed to the shopper

messagestring

A simple description of the resultCode.

pspReferencestring

The unique reference that is associated with the request.

referencestring

Reference of Pre-debit notification sent in my the merchant

resultCodestring

The code indicating the status of notification.

shopperNotificationReferencestring

The unique reference for the request sent downstream.

storedPaymentMethodIdstring

This is the recurringDetailReference returned in the response when token was created

Changes

Changed in 3 of the 38 revisions of this API.91

  • v253143012dc3448See the full diff
    • ▲

      the request's body type changed from no type to object

      request-body-type-changed

    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

  • v251f470dc9a7f91See the full diff
    • ○

      endpoint added

      endpoint-added

  • v25016d859e847f1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog