Set up a provider gateway
Enter the keys your payment provider gave you, register your Laramin's callback URL with the provider, and switch the gateway on so payers can choose it.
- Applies to
- Payment Gateway 4.0 and later
- Who can do this
- Platform owner, Administrator
- Permission
feature.pg. gateway.edit - Where
- Payment Gateway › Payment Gateways
On this page
A provider gateway connects your Laramin to a payment provider's account. This guide covers what every provider gateway has in common. For the exact keys and settings Razorpay needs, see Set up Razorpay.
Before you start
- You need List Gateway (
feature.) to open the list, and Edit Gateway (pg. gateway.list feature.) to change a gateway.pg. gateway.edit - Install and turn on the provider's add-on, for example Razorpay, and the Billing add-on, which takes the payments. See Upload and install an add-on.
- Work in the workspace whose merchant account this is, not in All Workspaces. See Switch workspace.
- Have your provider account's keys to hand. Keep them private: anyone with the secret key can act on your provider account.
Steps
-
In the sidebar, open Payment Gateway › Payment Gateways.
-
Find the provider's gateway. Its Gateway Type is Automatic.
-
Open the row's actions menu and select Edit.
-
Under Gateway Details, check Gateway Name. Payers see this name when they choose how to pay. Up to 40 characters.
-
Under Credentials, fill in each field the provider needs. Fields marked with
*are required. Each field's help text says where to find the value in the provider's dashboard. -
Copy the Callback URL and add it to your provider account, as the provider's guide describes. The provider sends payment confirmations to this address.
-
Set Status to Active.
-
Select Save.
You see Gateway … Updated Successfully!. The gateway's Availability shows Ready.
How keys are kept
- Keys are stored encrypted. Once saved, a secret is never shown again. Its field shows Stored instead.
- To keep a secret as it is, leave its field blank when you save. A blank secret never clears the stored one.
- To change a secret, type the new value and save.
- Laramin checks that the required fields are filled in, but it doesn't test the keys with the provider. Wrong keys are saved with Gateway … Updated Successfully!, and Availability still shows Ready, so check each key carefully when you paste it.
When Laramin refuses to switch it on
| Message | What to do |
|---|---|
| This gateway cannot be switched on: the addon that provides its … driver is not installed. | Install and turn on the provider's add-on, then try again. |
| This gateway cannot be switched on until these credentials are set: … | Fill in the fields the message names, then save again. |
| Switch to a single business before adding or changing payment gateways. | In the header's Workspace switcher, choose the workspace this gateway belongs to. |
These checks run only when you switch a gateway from Inactive to Active. A gateway that's already Active, such as the one Payment Gateway sets up at install, isn't checked. Open it and make sure its required keys show Stored or are filled in.
The Callback URL
- Every provider gateway has its own Callback URL, ending in a code that belongs to that gateway only. Register the URL exactly as shown.
- It's read-only. You can't change it, so the address you registered with your provider keeps working.
- It keeps working while the gateway is switched off, so payments the gateway already took can still be confirmed and refunded.
- The Billing add-on answers at this address. Without Billing, confirmations aren't received.
More than one gateway for a provider
If your workspace has two gateways for the same provider, the form shows Default. Turn it on for the gateway new payments should use. Turning it on for one gateway turns it off for the other. Payments already taken keep the gateway they were made through.
What happens next
- Choose which currencies the gateway accepts. See Choose the currencies a gateway accepts.
- If payers still aren't offered the gateway, see A gateway isn't offered or won't switch on.
Thanks. That helps us decide what to write next.
Thanks for telling us what was missing.
You already answered for this article today. Thanks.
We got a lot of answers from your network just now. Try again in a few minutes.
We couldn't send that. Check your connection and try again.
Links in this article
Printed from help.bsscn.com. The online article may have changed since.