Payment Gateways / Payment Methods
Payment gateways are used to accept payments from your users. You can create multiple payment gateways to offer your users more optionality. Without creating a payment gateway, users can't buy anything from your shop.
These common attributes are available for every gateway type:
| Attribute | Description |
|---|---|
| Type | The gateway type chosen when creating the gateway (read-only). |
| Name | Name of the gateway. |
| Subtitle | Subtitle shown during checkout. |
| Image | Optional. Default images are used when no image is uploaded. |
| Enabled | Enable the payment gateway. |
Depending on the selected type, additional attributes (such as environment, keys and secrets provided by the payment
provider) are shown. These are described in the per-gateway sections below. Secret attributes are write-only: once saved,
your input is not shown again and is only overwritten if you enter a new value. When editing a PayPal gateway,
a read-only Webhook URL field is also shown.
Deleting a gateway also deletes all purchases and payments that used it and cannot be undone. Consider disabling a gateway instead.
Please follow the instructions below to add a payment gateway.
PayPal
Supports recurring payments: yes
If you want to test the payments with a sandbox account first, do the steps below, but with a
SANDBOXapplication.
- Create a PayPal Business account or upgrade your account to a business account. If you don't want to upgrade your account, you can use the PayPal (Easy) integration (see below).
- Create a REST API app in the PayPal Developer settings. Make
sure to create the app for the
Liveenvironment. - Under
LIVE APP SETTINGS, enableTransaction Search, disable thePayoutsfeature and clickSave. - In your VyHub instance, create a PayPal payment gateway, select
PRODUCTIONenvironment and insert yourClient IDandClient Secret. - Click
Createand edit the payment gateway again. At the bottom, copy theWebhook URLto your clipboard. - Back in the
PayPal Developerportal, clickAdd WebhookunderLIVE WEBHOOKSand paste the copied URL. - Select
All events, scroll down and clickSave. - Copy the
Webhook IDof the created webhook into the form and clickEdit.
PayPal (Easy)
Supports recurring payments: no
The PayPal Easy/Legacy payment gateway is easier to set up and can be used without a PayPal business account. However, it has some limitations as it doesn’t support subscription payments, refunds and the general payment handling isn't as good as with the normal PayPal gateway.
- In your VyHub instance, create a PayPal (Easy) payment gateway, select
PRODUCTIONenvironment and insert your primary PayPal email address. - Click
Createand test if everything works fine.
Stripe
If you want to test the payments with a test account first, do the steps below, but with a
TESTapplication.
- Create a Stripe account or log into your existing one.
- Open Stripe Workbench and locate the
API keyssection. Create a new Public and Secret key or copy the already existing ones. - In your VyHub instance, create a Stripe payment gateway, insert your
Public KeyandSecret Keyand select your desiredPayment Methods. - Click
Create. - (Optional) Go to the Webhooks Tab, select the endpoint created by VyHub and click
Send test eventto test if everything works fine. - (Optional) In the settings of the payment gateway, enable
Accept pending paymentsto enable fast payment processing for the Stripe payment methods that take several hours/days until a payment is finished.
If you use a restricted API key instead of the standard secret key, make sure it has write permission for
Webhook Endpoints. Otherwise VyHub can't create the webhook and payments won't be processed.
The webhook is also kept up to date automatically: if the address of your instance changes, VyHub updates the endpoint, and when you delete the payment gateway, the endpoint is removed from your Stripe account again.
Paysafecard
Supports recurring payments: no
These are the instructions to become an official paysafecard partner. You can also create a payment gateway with manual code confirmation with a
Coupongateway (see below).
- Become a paysafecard partner.
- In your VyHub instance, create a Paysafecard payment gateway, insert your
API Keyand select your desiredEnvironment. - Click
Create. - As no IP addresses can be whitelisted, ask paysafecard to give you a cryptographic certificate for authentification.
The private key (
Client Key) and certificate (Client Certificate) can be set in the payment gateway settings. TheClient Certificateis usually in a file named something like001_manXXXXXXXXXX_XXXXXXXX_distributor_paysafecard_com.crt.
Credits
Supports recurring payments: no
- In your VyHub instance, create a credits payment gateway.
Create packets that have Credits as reward, so that users can buy credits with real money. You will need another
payment gateway for this.
Credits can be renamed with a name that matches your community (gulden, diamonds, ...). Rename in the
general-shopsettings.
Manually adding Credits
Credits can be manually added or removed from within the User Dashboard -> Purchases -> Credits.
It is possible to remove credits by entering a negative number of credits (e.g. -100 credits).
Coupon
Supports recurring payments: no
Coupon gateways can be used to manually approve coupons (e.g., paysafecard pins, amazon cards)
- In your VyHub instance, create a coupon payment gateway.
- After a purchase is made and coupons are entered by the user, the coupons need to be approved under
the
confirm purchasestab on theshop adminpage.
Free
Supports recurring payments: no
The Free payment gateway is an internal construct. It always exists, can't be deleted, and no other payment gateways
can be created with this type.
The Free payment gateway appears as a payment option whenever the total amount to pay is zero. This can happen if
there
is a zero packet price or a 100%
discount has been applied.