Subscription service - General information

Subscription service - General information

This service allow merchants to subscribe their customers to automatic collections in a set time window.

This functionality only allows subscription monthly payments. It will be deducted from the customer’s card every month, while the subscription is active.


All endpoints found in this article are from the Sandbox environment.


Additionally, this service handles the following subscriptions status: 


      1. Not paid: Occurs when the subscription payment fails. 
      2. Active: active subscription.
      3. On hold: Occurs when subscription payment fails 3 times
      4. Pending: Subscription pending payment (The scheduled payment failed because of the bank authorization)
      5. Cancelled: Subscription canceled, once the subscription is canceled it cannot be activated again.

Pre requirements

1. Have create credentials to access the sandbox environment. They can be created in our sandbox account https://sandbox-dashboard.greenpay.me/merchants/new.
2.Have card tokens registered in Greenpay, if not, visit our “Card tokenization Service”
3.Have a webhook URL configured to which the executed payments responses will be sent.

This section shows how to integrate the following functionalities: 


  1. Create subcription
  2. Cancel subscription
  3. Update amount
  4. Update payment method
  5. Manually payment
  6. List subscriptions
  7. List payment subscriptions


    • Related Articles

    • General Information

      This functionality allows you to create card tokens. Two ways are provided for this service. 1.  Directly call the API where the encrypted card information is sent. 2. Invoke the tokenization form, which is displayed in a browser window. If this form ...

    • Create subscription

      For this service, the following endpoint must be consumed:  https://sandbox-merchant.greenpay.me/subscriptions Step by step to successfully create a subscription in our API : 1. Create the JSON object to be sent It must contain the following ...

    • Cancel subscription

      For this service the following endpoint must be consumed:  https://sandbox-merchant.greenpay.me/subscriptions/cancel Below is the step by step to successfully unsubscribe in our API: 1. Create JSON object to be sent  The JSON must be structured as ...

    • General information - plugins

       Greenpay offers the possibility to integrate the checkout service on Magento 1.9 and Wordpress platforms through plugins. The functionalities provided by each plugin are the following:  Magento Checkout web form Wordpress Checkout web form ...

    • General information

      1. What is the Greenpay checkout or payment Gateway? The checkout is a functionality that allows merchants to charge credit or debit cards of their customers. 2. How to integrate the checkout? This service can be integrated in different ways: ...