In this section · 2 articles

Payment Gateway settings and permissions

Every column on the Payment Gateways list, every field on the provider and manual gateway forms, and the permissions that control each screen.

Applies to
Payment Gateway 4.0 and later
Who can do this
Platform owner, Administrator
Where
Payment Gateway › Payment Gateways
On this page

The Payment Gateways list

Payment Gateway › Payment Gateways lists the gateways of the workspace you're in, sorted by name.

ColumnWhat it shows
ImageThe gateway's logo.
Gateway NameThe name payers see.
Driver KeyThe gateway's fixed internal name, for example razorpay. It's made from the name when the gateway is created and never changes, because payments and the callback URL refer to it.
Gateway TypeAutomatic (a payment provider), Manual (a method you added) or Preloaded (a manual method that came with Payment Gateway).
AvailabilityReady, Switched off, or Driver missing when the provider's add-on isn't installed and turned on.
StatusActive or Inactive.
DefaultWhether new payments through this provider use this gateway, when the workspace has more than one for it.
BusinessThe workspace the gateway belongs to. Shown when you can see more than one workspace.
Supported CurrenciesFor a provider gateway, how many of its currencies are active. For a manual method, its one currency.

Each row's actions menu has Edit, plus Update Supported Currencies for a provider gateway or Update Gateway Fields for a manual or preloaded method. Delete appears only for Manual methods.

Gateway Details

On every gateway's form.

FieldWhat it doesRules
ImageThe logo payers see.Required when the gateway has none.
Gateway NameThe name payers see.Required. Up to 40 characters. For a new method, it must be unique in the workspace, ignoring spaces and capitals.
StatusActive or Inactive.Required. Active for a new method.
DefaultMakes this the gateway new payments through this provider use.Shown only when the workspace has another gateway for the same provider.
DescriptionA note about the method.Manual and preloaded methods only.
The Gateway Details section of a new manual payment method's form, with an Image upload area, an empty Gateway Name field, Status set to Active, and a Description box.

Credentials

On a provider gateway's form. The fields come from the provider's add-on. For Razorpay, see Set up Razorpay.

ItemWhat it does
Chips at the topWhat the provider can do, as its add-on reports it, for example webhooks or refunds.
Provider fieldsThe keys the provider gave you. Required ones are marked *. A saved secret shows Stored and is never shown again. Leave it blank to keep it.
Callback URLThis gateway's own address for the provider's confirmations. Read-only. Copy it into the provider's dashboard.

If the provider's add-on isn't installed, the section shows Driver not installed instead of the fields. The saved keys are kept.

Currency & Charges

On a manual or preloaded method's form. The method accepts one currency.

FieldRules
CurrencyRequired. One of your active currencies. Starts on your default currency.
SymbolRequired. Up to 40 characters.
Conversion RateRequired. 0 or more. Units of this currency per one unit of your default currency.
Min AmountRequired. 0 or more.
Max AmountRequired. At least Min Amount.
Percentage ChargesRequired. From 0 to 100.
Fixed ChargesRequired. 0 or more.
The Currency & Charges section of a new manual method's form, with Currency set to INR — Indian Rupee, Symbol ₹, Conversion Rate 1.000, and Min Amount, Max Amount, Percentage Charges and Fixed Charges at 0.

[Confirm: in Payment Gateway 4.0.1 with Billing 2.0.0, the amounts, charges and rate are saved but not applied to any payment.] The same fields, per currency, are on a provider gateway's Update Supported Currencies screen. See Choose the currencies a gateway accepts.

Deposit Instructions

On a manual or preloaded method's form: what the payer is shown after choosing the method. Select Add Instruction for each row, and drag rows to reorder them.

FieldRules
TypeText, Image or Link.
TitleUp to 255 characters. Required when Value is filled in.
ValueUp to 2,000 characters. Required when Title is filled in.

Rows missing a type, title or value aren't saved.

Payer fields

Update Gateway Fields on a manual or preloaded method. The custom fields the payer fills in, in order. See Add a manual payment method.

ColumnWhat it shows
OrderThe position the payer sees it in. Change it with Move up and Move down.
Title, Name, TypeFrom the field's definition in Custom Fields.
RequiredRequired or Optional, from the field's definition.
Payer fields screen for the Cheque or demand draft method, listing four fields with their Order, Title, Name, Type and Required or Optional status, plus Move up, Move down and remove controls.

Permissions

In the role editor, these are under Currencies & Gateways. Payment Gateway has no roles of its own.

PermissionLabelAllows
feature.pg.gateway.listList GatewayOpening Payment Gateways, a gateway's form, its currencies and its payer fields.
feature.pg.gateway.createCreate GatewayAdding manual methods.
feature.pg.gateway.editEdit GatewayChanging any gateway, its keys, its currencies and its payer fields.
feature.pg.gateway.deleteDelete GatewayDeleting manual methods. Deleting is permanent.
Role editor for Accounts Manager filtered to 'gateway', showing the Payment Gateway band's Currencies & Gateways group with the Gateway row's List, Create, Edit and Delete permissions; only List is granted.

The permissions for payments, refunds and tax rules belong to Billing; see Billing permissions and server settings. To give these, see Give someone a role.