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.
| Attribute | Description |
|---|---|
| Name | Name of gateway |
| Subtitle | Subtitle shown during checkout |
| Image URL | [Optional] Image URL of the payment gateway. When no image is set, defaults are used |
| Enabled | Enable the payment gateway |
| Environment | Environment of gateway (Sandbox / Production) |
| Secrets | Secrets provided by payment providers |
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.
- (Only required before Sepember 2024) Enable
Stripe Workbenchhere. - Open Stripe Workbench and locate the
API keyssection. - In your VyHub instance, create a Stripe payment gateway, insert your
Public KeyandPrivate Keyand select your desiredPayment Methods. - Click
Createand edit the payment gateway again. At the bottom, copy theWebhook URLto your clipboard. - Create a webhook endpoint
using this link,
click
Continueand insert the copied URL toEndpoint URL. Then clickCreate. - Go to the Webhooks Tab, select the created endpoint and click
Revealon theSigning Secretand copy it to your clipboard. - Back at the VyHub settings of your Stripe gateway, insert the copied secret into the
Webhook Secretfield and clickEdit. - (Optional) In the
Stripesettings of the created webhook endpoint, clickSend 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 gateways that take several hours/days until a payment is finished.
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.