# biticaret.app.toml keys

> Every key in biticaret.app.toml, its type and its description.

This page is generated from the source code. `a.b` denotes key `b` in table `[a]`, and `a[].b` denotes key `b` in each item of the `[[a]]` array of tables. For how these files work, see [App configuration files](../apps/configuration.md).

| Key | Type | Description |
| :--- | :--- | :--- |
| `client_id` | string | The app's client ID. Written by app config link; used by the CLI to identify the app and owning organisation. |
| `handle` | string | The app's URL handle: lowercase letters, digits and hyphens, at most 50 characters. |
| `name` | string | Display name of the app shown to stores. |
| `application_url` | string | The app's base HTTPS URL. Other URLs in this file can be written as relative paths resolved against this URL's origin. |
| `access_scopes.scopes` | string array | Scopes requested by the app and approved by the store during installation. See the Scopes page. |
| `auth.redirect_urls` | string array | Allowed OAuth callback URLs. |
| `customer_data.level` | integer | Customer data access level: 0 (none), 1 (without names or contact details) or 2 (including names and contact details). Required whenever scopes or features access customer data. |
| `customer_data.reason` | string | Explanation of why the app needs customer data; required for level 1 and above. |
| `privacy.customers_data_request_url` | string | Endpoint for the customers/data_request privacy topic (KVKK, required). |
| `privacy.customers_redact_url` | string | Endpoint for the customers/redact privacy topic (KVKK, required). |
| `privacy.store_redact_url` | string | Endpoint for the store/redact privacy topic (KVKK, required). |
| `webhooks.subscriptions[].topics` | string array | Webhook topics for this subscription. See the Webhook topics page. |
| `webhooks.subscriptions[].uri` | string | Endpoint URL where this subscription's webhook topics are delivered. |
| `app_proxy.subpath` | string | Storefront subpath routed to the app: requests under /apps/\<subpath> are proxied to your app. |
| `app_proxy.url` | string | Backend URL where app proxy requests are forwarded. |
| `app_proxy.large_responses` | boolean | When true, requests extended app proxy limits (120 s and 256 MiB for GET and HEAD); takes effect once approved by the platform, and requesting this never causes a version to be rejected. |
| `app_proxy.large_responses_reason` | string | Explanation of why large proxy responses are needed; required when large_responses is true, at most 1,000 characters. Shown during review. |
| `admin_embedded.entry_url` | string | URL loaded inside the admin iframe as the app's home page. |
| `admin_embedded.navigation[].label` | string | Display label of a navigation link under the app in the admin. |
| `admin_embedded.navigation[].path` | string | Navigation link path relative to entry_url. |
| `payments_app.label` | string | Payment method label shown at checkout. |
| `payments_app.payment_session_url` | string | Endpoint where payment session requests are sent. |
| `payments_app.refund_session_url` | string | Endpoint where refund requests are sent. |
| `payments_app.capture_session_url` | string | Endpoint where capture requests are sent. |
| `payments_app.void_session_url` | string | Endpoint where void requests are sent. |
| `payments_app.supported_currencies` | string array | Accepted currency codes (ISO 4217, e.g. TRY). |
| `payments_app.supports_installments` | boolean | Whether the app supports installment payments. |
| `payments_app.supports_installment_quotes` | boolean | Whether the app returns dynamic installment options at installment_quote_url; without it, payments are single-charge only. |
| `payments_app.installment_quote_url` | string | Endpoint queried for installment quote options. |
| `payments_app.supports_3ds` | boolean | Whether the app performs 3D Secure verification. |
| `payments_app.invoice` | boolean | Shows the method as invoice-based at checkout and keeps the order pending until captured by the store. Meaningful only with B2B company location payment terms. |
| `payments_app.test_only` | boolean | Marks the app as test-mode only, processing no real funds. The platform sends only test: true requests, and a store cannot go live while this is enabled. |
| `sms_provider` | boolean | When true, stores can select the app as their SMS provider: notification SMS arrive via sms/send (requires write_sms). |
| `sms_commercial` | boolean | When true, the SMS provider app can send campaign (commercial) SMS through the IYS filter and sync store consents to IYS via iys/consent; requires sms_provider. |
