Tabby Payment Extension

Extension Installation

Preliminary Works

The following information is requested from the provider for the brand-specific and production (live) environment.

• TABBY_URL

• TABBY_PUBLIC_KEY

• TABBY_SECRET_KEY

• TABBY_MERCHANT_CODES

A secret_key is generated with a minimum length of 41 characters. The generated key must be kept throughout the installation. An example command line to generate a random key:

openssl rand -base64 41

A hash_key must also be generated with a minimum length of 32 characters. The generated key must be kept throughout the installation.

Payment Package

In order for the Tabby Payment Extension to be installed, the Payment Package installation must be completed.

Environment Variables

The extension installed to the relevant project in ACC must have the following environment variables. Environment variables can be entered before or after the deployment phase. As changes are made to the environment variables, the deployment process must be performed again.

Variable	Description
Extension-specific
TABBY_URL	URL received during the preliminary works phase (without a trailing slash at the end)
TABBY_PUBLIC_KEY	Public Key received during the preliminary works phase
TABBY_SECRET_KEY	Secret Key received during the preliminary works phase
TABBY_MERCHANT_CODES	Each currency to be used requires a merchant code. Example: TABBY_MERCHANT_CODES={"AED":"rnb_ae_aed","SAR":"rnb_sa_sar"}
WEBHOOK_URL	https://{SHOP_URL}/orders/hooks/payment
WEBHOOK_USERNAME	Webhook username
WEBHOOK_PASSWORD	Webhook password
Generic
SECRET_KEY	The generated secret key during the preliminary works phase
HASH_KEY	The generated hash key during the preliminary works phase
ADMIN_EMAIL	The e-mail address of the installer can be entered
ADMIN_PASSWORD	A newly created and extension-specific strong password
ADMIN_USERNAME	A username can be entered (example: ‘akinon’)

Omnitron Settings

The installed extension must also be defined to the project via Omnitron. This can be done on the Payment Options & Add/Edit POS Integration pages. After the settings are completed, it will be accessible under a new tab on the payment screen as it is a redirection type payment integration.

Payment Options

One payment option must be defined in Omnitron to be specific for the extension installed. Explanations on how the settings should be made at this stage are in the table below.

Note: Do not set more than one active payment option with the type “masterpass” or “credit card”.

Field	Description
Payment Option	Redirect to bank
Payment Option Name	Tabby
Payment Option Slug	tabby
Config*	{"pos_slug":"tabby"}

* Fields other than pos_slug should be determined according to the requirements.

POS Integration

One POS integration must be defined in Omnitron to be specific for the extension installed. Explanations on how the settings should be made at this stage are in the table below.

Field	Description
Name	Tabby
Slug	tabby
Gateway	Extension
Resource URL	EXTENSION URL
Username	ADMIN_USERNAME value in environment variables
Password	ADMIN_PASSWORD value in environment variables
Hash Key	Random hash key
Payment Type	AUTH

Webhook

Webhook registration should occur after the extension is created.

Webhook API Docs

An example request is provided below for creating a webhook:

curl --location --request POST 'https://api.tabby.ai/api/v1/webhooks' \
--header 'X-Merchant-Code: {MERCHANT_CODE}' \
--header 'Authorization: Bearer {TABBY_SECRET_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "{EXTENSION_URL}/webhook/",
    "is_test": true,
    "header": {
        "title": "Authorization",
        "value": "Basic base64({WEBHOOK_USERNAME}:{WEBHOOK_PASSWORD})"
    }
}'

Additional Notes

Useful links:

• Tabby Docs

• Tabby API Reference