For the complete documentation index, see llms.txt. This page is also available as Markdown.

Iyzico

To use the iyzico payment gateway in Mavibot, you need to obtain your API credentials from your iyzico merchant account and enter them in the integration settings.

Obtaining API Credentials

  1. Sign in to your iyzico Merchant Panel.

  2. Go to Settings → API Keys (Merchant API Keys).

  3. Copy the following credentials:

    • API Key

    • Secret Key

These credentials are required to connect iyzico to Mavibot.

For testing, iyzico provides separate credentials with the sandbox- prefix. If you enter these credentials, all payments will automatically be processed in Sandbox (test) mode—no additional configuration is required. To accept live payments, use your production credentials (without the sandbox- prefix).

Connecting iyzico

In the Acquiring tab, select iyzico.

Then enter:

  • API Key — your API key.

  • Secret Key — your Secret Key.

The integration is now complete.

Calculator function:

get_iyzico_payment_url(amount, description, currency, customer_email, customer_phone, full_name, identity_number, city, country, address, product_name, language)

Parameters

Parameter
Description
Required
Default / Allowed Values

amount

Payment amount.

description

Payment description.

No

currency

Payment currency.

No

Default: TRY Supported: TRY, USD, EUR, GBP, CHF, NOK

customer_email

Customer's email address.

No

customer_phone

Customer's phone number in international format (for example, +905XXXXXXXXX).

No

full_name

Customer's full name.

No

identity_number

Customer's identification number (for customers in Turkey, this is the TCKN).

No

city

Customer's city.

No

country

Customer's country.

No

address

Customer's address.

No

product_name

Product name displayed on the payment page. If omitted, description is used.

No

Uses description

language

Language of the payment page.

No

Default: en Supported: en, tr

The function returns a payment URL.

example

To send a button with a payment link, select the Payment Button type and choose iyzico as the payment gateway. Then enter the product name, payment amount, and, if necessary, the payment currency.

Payment Callbacks

After the customer opens the payment link and completes the payment, the following callback is sent to the conversation upon a successful payment:

SDJ91MTKTT_success 100

Where:

  • SDJ91MTKTT is the first 10 characters of your Secret Key.

  • 100 is the payment amount.

If the payment fails, the following callback is sent:

SDJ91MTKTT_fail 100

Customer Variables After a Successful Payment

Variable
Value

iyzico_callback_data

Payment information received from iyzico

iyzico_payment_completed

"True" if the payment was successfully processed

iyzico_payment_id

iyzico payment ID

Last updated