LiqPay Payments Extended

Demo to preview the settings

Introduction

The plugin is intended for payment through the LiqPAY system.
Connect the payment system LiqPay to your site.
  • Create a subscription
  • Unsubscribe
  • Easy Payment

Prerequisites

In order to interact with the plugin you'll need to get the PUBLIC and SECRET KEY from LiqPay.

How to setup

  1. Go to LiqPay and click on the “Sign Up” or “Log in” button.
  1. On the opened page, insert the phone number then click on the “Sign in” button.
    1. ⚠️
      For successful account creation, you should have a Ukrainian number.
Image without caption
  1. Fill out the form with the company name and email address then click on the “Create a shop” button.
    1. Image without caption
  1. On the right side of the home page, you will find the keys for the plugin settings.
Image without caption
  1. Put the LiqPay test keys on the “PUBLIC_KEY - dev.” and “PRIVATE_KEY - dev.” inputs. And, put the LiqPay production keys on the “PUBLIC_KEY” and “PRIVATE_KEY” inputs.
Image without caption

PLUGIN ACTIONS DETAILED

  1. CheckoutSubscription - This action should be used to create a subscription.
    1. Fields:
      Title
      Description
      Type
      Amount
      Payment amount. Example: 5, 7.34
      number
      Currency
      Payment currency. Possible values: USD, EUR UAH, BYN, KZT. Additional currencies can be added at the company's request.
      text
      Description
      Payment description.
      text
      Order ID
      Unique purchase ID in your shop. The maximum length is 255 symbols.
      text
      Subscribe date start
      Date of the first payment. Time must be specified in the following format 2015-03-31 00:00:00 UTC. If the past date is indicated - the subscription will be activated with the date and time of the request.
      text
      Subscribe periodicity
      Period of payments. Possible values: month - once in a month; year - once in a year
      text
      Expired date
      Expired date of payment into the following format 2015-03-31 00:00:00 UTC.
      text (optional)
      Language
      Customer's language ru, uk, en.
      text (optional)
      Paytypes
      Comma-separated methods for payment. Available methods: card, liqpay, liqpay, privat24, masterpass, masterpass, moment_part, cash, invoice, qr.
      text (optional)
      Result url
      URL of your shop where the buyer would be redirected after completion of the purchase. Maximum length 510 symbols.
      text (optional)
      Info
      Information to add details to payment. For example: "External information for payments”.
      text (optional)
      Product category
      Product category in your shop. The maximum length is 25 symbols.
      text (optional)
      Product description
      Product description in your shop. The maximum length is 500 symbols.
      text (optional)
      Product name
      Product name in your shop. The maximum length is 100 symbols.
      text (optional)
      Product url
      Product page address. The maximum length is 2000 symbols.
      text (optional)
      Returns:
      Title
      Description
      Type
      redirect to
      The link for redirecting to payment page after the payment request.
      text
      error
      The error message when the payment request fails.
      text
  1. CancelSubscription - This action should be used to cancel a subscription.
    1. Fields:
      Title
      Description
      Type
      Order ID
      Unique purchase ID in your shop. The maximum length is 255 symbols.
      text
      Returns:
      Title
      Description
      Type
      result
      Payment status. Available values: error - Failed payment. Data is incorrect; failure - Failed payment; success - Successful payment; unsubscribed - Subscribed successfully deactivated.
      text
      error
      The error message when the payment request fails.
      text
  1. CheckoutPay - This action should be used for a one time payment.
    1. Fields:
      Title
      Description
      Type
      Amount
      Payment amount. Example: 5, 7.34
      number
      Currency
      Payment currency. Possible values: USD, EUR UAH, BYN, KZT. Additional currencies can be added at the company's request.
      text
      Description
      Payment description.
      text
      Order ID
      Unique purchase ID in your shop. The maximum length is 255 symbols.
      text
      Expired date
      Expired date of payment into the following format 2015-03-31 00:00:00 UTC.
      text
      Language
      Customer's language ru, uk, en.
      text
      Paytypes
      Comma-separated methods for payment. Available methods: card, liqpay, liqpay, privat24, masterpass, masterpass, moment_part, cash, invoice, qr.
      text
      Result url
      URL of your shop where the buyer would be redirected after completion of the purchase. Maximum length 510 symbols.
      text
      Info
      Information to add details to payment. For example: "External information for payments”.
      text
      Product category
      Product category in your shop. The maximum length is 25 symbols.
      text
      Product description
      Product description in your shop. The maximum length is 500 symbols.
      text
      Product name
      Product name in your shop. The maximum length is 100 symbols.
      text
      Product url
      Product page address. The maximum length is 2000 symbols.
      text
      Returns:
      Title
      Description
      Type
      redirect to
      The link for redirecting to payment page after the payment request.
      text
      error
      The error message when the payment request fails.
      text

Workflow example

How to create a subscription

How to cancel a subscription

How to pay for an order

Changelogs