For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subscription

The PayForm can be configured to collect subscription type payments.

In order to do this, you can adjust your request as follows:

"eFeatures": "0001",

This will provide for your final redirect address as well as a webhook URL

Here are other changes you will need to consider:

"eSubmission": "0221", "eFeatures": "0001", "WTYPE": "PF", "EndPoint": "Payform/PF.aspx", "PostURL": "https://easypay1.com/postingapp/submit.aspx", // your webhook location "RedirectURL": "https://easypay8.com/CYWidget/", // your redirect URL

You can add the following section to your initialization request to describe your desired subscription:

"Subscription": { "Amount": 20.0, "Period": "WEEKLY", "FirstPayDate": "2026-02-11" },

Note: You must use a date which is today or future, or an error will occur.

Valid subscription periods:

  • WEEKLY

  • BI_WEEKLY

  • TWICE_MONTHLY

  • MONTHLY

  • BI_MONTHLY

  • QUARTERLY

  • SEMI_ANNUALLY

  • ANNUALLY

Operation

The Subscription PayForm is designed to do the following:

  1. Collect an independent Fee ( optional )

  2. Create a Subscription consent ( stored card )

  3. Do the initial charge ( depending on "FirstPayDate":)

Fig 1 (when a fee is also required):

Fig 2 (when NO fee is required initially):

Here is a full request (for Fig 2):

Behavior

You will continue to get webhooks throughout the lifetime of your subscription

Here are some examples:

Cancelling a subscription

In order to discontinue automatic payments for a given subscription you must cancel the subscription using the API.

Cancel a consent subscription | Docs

Last updated

Was this helpful?