Payment Gateways
You need to create a payment gateway to accept payments.
| Attribute | Description |
|---|---|
| Name | Name of gateway |
| Subtitle | Subtitle shown during checkout |
| 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.
- 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.
Stripe
Supports recurring payments: yes
Supported Stripe API version: 2022-08-01 and older
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.
- In the Stripe
Developerssettings, navigate toAPI keys. - 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. - Back at the Stripe
Developerssettings, navigate toWebhooks. -
Click
Add (hosted) endpoint, insert the copied URL toEndpoint URLand selectLatest API version. Add the following events and clickAdd endpoint:checkout.session.completedinvoice.paidcustomer.subscription.deleted
-
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.
Paysafecard
Supports recurring payments: no
- Become a paysafecard partner.
- In your VyHub instance, create a Paysafecard payment gateway, insert your
Secret Keyand select your desiredEnvironment. - Click
Create.
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 an other payment gateway for this.
Coupons
Supports recurring payments: no
Coupon gateways can be used to manually approve coupons (e.g. paysafecard pins)
- 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 payment option whenever the total amount to pay is zero. This can happen if a 100% discount has been applied.