Subscription

The PayForm can be configured to collect subscription type payments

In order to do this you will want to provide the following:

"eSubmission": "0221",

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", "WTYPE": "PFS", "EndPoint": "Payform/PFS.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 | Docsarrow-up-right

Last updated

Was this helpful?