Guide / Payment Providers
KO EN

Payment Providers

The Payment Providers page allows administrators to register and manage the basic information of payment companies used by the iBoard payment system.

Use Payment Providers to define the payment company itself, such as Stripe or Authorize.Net. Use Payment Configs to enter detailed connection information such as API keys, secret keys, environment settings, webhook URLs, and merchant-specific credentials.

Overview

Payment Providers work as the master list of payment companies. A provider defines the payment gateway type, activation status, display order, and basic notes.

A provider does not usually store sensitive gateway credentials directly. Instead, the detailed configuration for each provider should be managed in the Payment Configs menu.

Menu Purpose
Payment Providers Registers the basic payment company information, such as provider code, provider name, active status, and sort order.
Payment Configs Stores detailed payment gateway settings such as API credentials, mode, merchant account data, and connection options.

Provider List

The Provider List displays all registered payment providers. From this screen, administrators can add, edit, delete, activate, or filter payment providers.

Top Actions

Button Description
+ New Opens the Provider Edit page to register a new payment provider.
Only Active Displays only active payment providers.
Show All Displays both active and inactive payment providers.
Seed Defaults Creates or restores default provider records, such as Stripe and Authorize.Net.

Provider Table

Column Description
ID The internal provider ID.
Code The unique provider code, such as STRIPE or AUTHNET.
Name The payment provider display name.
Active Shows whether the provider is currently active or inactive.
Sort Controls the display order of providers.
Updated The last updated date and time.
Manage Provides the Edit and Delete actions.

Provider Edit

The Provider Edit page is used to create or update the basic information of a payment provider.

ProviderName Select

Select a predefined provider from the dropdown list. When a provider is selected, the provider code may be filled automatically.

Common provider examples include:

  • Stripe
  • Authorize.Net
  • Other (Custom)

ProviderName Custom

This field is used only when Other (Custom) is selected. Enter the custom payment provider name here. 

Example:
MyGateway
CustomPay
LocalMerchantProvider

ProviderCode

The ProviderCode is the unique code used internally to identify the payment provider. It is recommended to use uppercase letters, numbers, and underscores only. 

Recommended:
STRIPE
AUTHNET
MY_GATEWAY
CUSTOM_PAY

Avoid:
Stripe Payment
my gateway!!
custom-provider-name-with-spaces
The provider code should remain stable after it is used by payment configurations or transactions. Changing the provider code later may affect connected payment settings.

IsActive

Controls whether the provider is available for use.

Value Meaning
true The provider is active and can be used in payment configuration.
false The provider is inactive and should not be used for new payment configuration.

SortOrder

SortOrder controls the display order of payment providers. A smaller number usually appears before a larger number. 

Example:
10 - Stripe
20 - Authorize.Net
30 - Custom Gateway

Notes

Use the Notes field to store internal information about the provider. Do not store sensitive credentials such as secret keys or API passwords in this field.

Recommended Workflow

  1. Open Admin > Payment > Providers.
  2. Click Seed Defaults if the default providers have not been created yet.
  3. Click + New to add a new provider, or click Edit to update an existing provider.
  4. Select a predefined provider or choose Other (Custom).
  5. Confirm or enter the ProviderCode.
  6. Set IsActive to true if the provider should be available.
  7. Enter the SortOrder.
  8. Add internal notes if needed.
  9. Click Save.
  10. Go to Payment > Configs to enter detailed payment gateway settings.

Relationship Between Providers and Configs

The provider record identifies the payment company. The config record stores the actual connection details.

Information Type Where to Manage
Payment company name Payment Providers
Provider code Payment Providers
Active or inactive status Payment Providers
API key Payment Configs
Secret key Payment Configs
Merchant ID Payment Configs
Sandbox or production mode Payment Configs
Webhook or callback settings Payment Configs

Common Use Cases

Use Case Recommended Action
Add Stripe as a payment provider Select Stripe, confirm the code as STRIPE, activate it, and save.
Add Authorize.Net Select Authorize.Net, confirm the code as AUTHNET, activate it, and save.
Add a custom gateway Select Other (Custom), enter the custom provider name, set a unique provider code, and save.
Temporarily disable a provider Edit the provider and set IsActive to false.
Restore missing default providers Click Seed Defaults.

Important Notes

  • Provider records store basic payment company information only.
  • Detailed credentials and gateway settings should be managed in Payment Configs.
  • Do not store secret keys, passwords, or private credentials in the Notes field.
  • Use stable provider codes because they may be referenced by payment configs or transaction records.
  • Inactive providers should not be used for new payment configurations.
  • Before deleting a provider, confirm that it is not used by any payment configuration or transaction history.

Troubleshooting

Problem Possible Cause Solution
A provider does not appear in payment configuration The provider may be inactive. Edit the provider and set IsActive to true.
ProviderCode is empty A custom provider was selected but the provider code was not entered. Enter a unique provider code or click Auto if available.
Default providers are missing The default provider records have not been seeded. Click Seed Defaults.
Payment still does not work after adding a provider The provider was added, but detailed configuration has not been entered. Go to Payment > Configs and enter the required gateway settings.
Cannot delete a provider The provider may be referenced by existing configs or transactions. Disable the provider instead of deleting it, or remove dependent configurations first.

Best Practices

  • Create or confirm providers before creating payment configs.
  • Use clear and stable provider codes such as STRIPE or AUTHNET.
  • Use Only Active to focus on providers currently available for payment setup.
  • Use Seed Defaults only when default provider records are missing or need to be restored.
  • Keep credentials in Payment Configs, not in Payment Providers.
  • Deactivate unused providers instead of deleting them when transaction history may exist.
Payment Providers define the payment company. Payment Configs define how that company connects to your actual merchant account. Always configure both correctly before accepting real payments.