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
SANDBOX
application.
- 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
Live
environment. - Under
LIVE APP SETTINGS
, enableTransaction Search
, disable thePayouts
feature and clickSave
. - In your VyHub instance, create a PayPal payment gateway, select
PRODUCTION
environment and insert yourClient ID
andClient Secret
. - Click
Create
and edit the payment gateway again. At the bottom, copy theWebhook URL
to your clipboard. - Back in the
PayPal Developer
portal, clickAdd Webhook
underLIVE WEBHOOKS
and paste the copied URL. - Select
All events
, scroll down and clickSave
.
Stripe
Supports recurring payments: yes
Supported Stripe API version: 2022-11-15 and older
If you want to test the payments with a test account first, do the steps below, but with a
TEST
application.
- Create a Stripe account or log into your existing one.
- In the Stripe
Developers
settings, navigate toAPI keys
. - In your VyHub instance, create a Stripe payment gateway, insert your
Public Key
andPrivate Key
and select your desiredPayment Methods
. - Click
Create
and edit the payment gateway again. At the bottom, copy theWebhook URL
to your clipboard. - Back at the Stripe
Developers
settings, navigate toWebhooks
. -
Click
Add (hosted) endpoint
abd insert the copied URL toEndpoint URL
. Add the following events and clickAdd endpoint
:checkout.session.completed
invoice.paid
customer.subscription.deleted
-
Click
Reveal
on theSigning Secret
and copy it to your clipboard. - Back at the VyHub settings of your Stripe gateway, insert the copied secret into the
Webhook Secret
field and clickEdit
. - (Optional) In the
Stripe
settings of the created webhook endpoint, clickSend test event
to test if everything works fine. - (Optional) In the settings of the payment gateway, enable
Accept pending payments
to enable fast payment processing for the Stripe payment gateways that take several hours/days until a payment is finished.
Paysafecard
Supports recurring payments: no
This are the instructions to become an official paysafecard partner. You can also create a payment gateway with manual code confirmation with a
Coupon
gateway (see below).
- Become a paysafecard partner.
- In your VyHub instance, create a Paysafecard payment gateway, insert your
API Key
and 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 Certificate
is 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 an other payment gateway for this.
Coupon
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 purchases
tab on theshop admin
page.
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.