Kirby Pay

# Options

# Options list

Kirby Pay comes with many options to configure to achieve proper operation according to the needs of each project scenario. All the options needs the prefix beebmx.kirby-pay.

Option Default Value Description
name Business (string) Set the default name of the buisness
env production (string) Set the current enviroment. Accepts local, test or production
service sandbox (string) Set the service used to process payments: sandbox, stripe or conekta
service_key null (string) Set the public key of the service
service_secret null (string) Set the secret key of the service
locale en_US (string) Set the locale for the services
locale_code en (string) Set the code for Kirby localization
currency usd (string) Set the currency with ISO 4217
money_precision 2 (int) Set the precision for the money
date_format Y-m-d H:m:s (string) Set the date format for the panel display
default_item_name Item to sell (string) Set the default item name for the products or services
shipping false (bool) Hide or show shipping options in the form
default_country null (string) If shipping is enable set the default country selected (ISO 3166-1 2 letters country code)
countries null (array) Define only the countries you need to ship (ISO 3166-1 2 letters country code)
payment_types ['card'] (array) Set the allowed method payments
payment_process charge (string) Set the process of the payment charge or order
payment_expiration_days 30 (int) Set the expiration days for oxxo_charge in conekta service
pay_id_length 6 (int) Set the length to display in panel
pagination 10 (int) Set the number of rows to be displayed per page in the panel
redirect thanks (string) Set the URL to redirect if the payment was successful
redirect_customer_create customer (string) Set the URL to redirect if the customer was created
redirect_customer_update profile (string) Set the URL to redirect if the customer was updated
redirect_source_update profile (string) Set the URL to redirect if the source payment was updated
storage /pay (string) Set the location where payment files will be stored
extra_amounts_item Extra (string) Extra item label
logs false (bool) Enable or disable webhooks logs
styles (array) Update default styles

# Example

Here is an example to configure the stripe driver. In your Kirby configuration file config.php just add:

$base = dirname(dirname(__DIR__));
$storage = $base . '/storage/pay';

return [
    'beebmx.kirby-pay.service' => 'stripe',
    'beebmx.kirby-pay.service_key' => 'pk_test_stripe_key',
    'beebmx.kirby-pay.service_secret' => 'sk_test_stripe_secret',

    'beebmx.kirby-pay.default_country' => 'US',
    'beebmx.kirby-pay.storage' => $storage,
    'beebmx.kirby-pay.env' => 'test',
    'beebmx.kirby-pay.logs' => true
];

← Styles →