POST /notifyShopper

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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
shopperReference String Yes

The ID that uniquely identifies the shopper.

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

billingSequenceNumber String No

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

billingDate String No

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

recurringDetailReference String No

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

amount Object Yes

The amount of the upcoming payment.

amount.value Integer Yes

The amount of the transaction, in minor units.

amount.currency String Yes

The three-character ISO currency code.

merchantAccount String Yes

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

reference String Yes

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

displayedReference String No

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

storedPaymentMethodId String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.