Pay with Iyzico Payment Extension

Extension Installation

Preliminary Works

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

  • API_URL

  • API_KEY

  • API_SECRET_KEY

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.

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

API_URL

URL received during the preliminary works phase (without a trailing slash at the end)

API_KEY

API Key received during the preliminary works phase

API_SECRET_KEY

API Secret Key received during the preliminary works phase

PAYMENT_SOURCE

The preferred payment source. It is optional. The default value is AKINON, and for detailed information, the Iyzico documentation can be reviewed.

ALLOWED_INSTALLMENTS

Installment options that will be allowed. The permitted installment amounts must be entered as defined within an array. For example, ["1", "2", "3", "6", "9"]. For detailed information, the Iyzico documentation can be reviewed.

PAYMENT_GROUP

The preferred payment group. It is optional. The default value is PRODUCT, and for detailed information, the Iyzico documentation can be reviewed*.

WEBHOOK_URL

https://{SHOP_URL}/orders/hooks/payment

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’)

Notes

* Detailed information about PAYMENT_SOURCE, ALLOWED_INSTALLMENTS, and PAYMENT_GROUP can be found in the table under the PWI Başlatma page.

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.

Field
Description

Payment Option

Redirect to bank

Payment Option Name

Pay with Iyzico Extension

Payment Option Slug

pwi_extension

Config*

{"pos_slug":"pwi_extension"}

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

Pay with Iyzico Extension

Slug

pwi_extension

Gateway

Extension

Resource URL

EXTENSION URL

Username

ADMIN_USERNAME value in environment variables

Password

ADMIN_PASSWORD value in environment variables

Hash Key

The generated hash key during the preliminary works phase

Payment Type

Auth

Webhook

To use the Pay with Iyzico Extension with a webhook, the Webhook Activation process must be completed on Iyzico. The necessary steps for this process can be followed on the Iyzico Docs Webhook page. During the setup, the "{EXTENSION_URL}/webhook" URL must be used.

Additional Notes

Useful links:

Last updated

Was this helpful?