Reference
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.
Top-level keys
client_id
The app's client ID. Written by app config link; used by the CLI to identify the app and owning organisation.
- Type
- string
Example
client_id = "…"handle
The app's URL handle: lowercase letters, digits and hyphens, at most 50 characters.
- Type
- string
Example
handle = "…"name
Display name of the app shown to stores.
- Type
- string
Example
name = "…"application_url
The app's base HTTPS URL. Other URLs in this file can be written as relative paths resolved against this URL's origin.
- Type
- string
Example
application_url = "…"sms_provider
When true, stores can select the app as their SMS provider: notification SMS arrive via sms/send (requires write_sms).
- Type
- boolean
Example
sms_provider = truesms_commercial
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.
- Type
- boolean
Example
sms_commercial = trueaccess_scopes
access_scopes.scopes
Scopes requested by the app and approved by the store during installation. See the Scopes page.
- Type
- string array
Example
[access_scopes]
scopes = ["…"]auth
auth.redirect_urls
Allowed OAuth callback URLs.
- Type
- string array
Example
[auth]
redirect_urls = ["…"]customer_data
customer_data.level
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.
- Type
- integer
Example
[customer_data]
level = 1customer_data.reason
Explanation of why the app needs customer data; required for level 1 and above.
- Type
- string
Example
[customer_data]
reason = "…"privacy
privacy.customers_data_request_url
Endpoint for the customers/data_request privacy topic (KVKK, required).
- Type
- string
Example
[privacy]
customers_data_request_url = "…"privacy.customers_redact_url
Endpoint for the customers/redact privacy topic (KVKK, required).
- Type
- string
Example
[privacy]
customers_redact_url = "…"privacy.store_redact_url
Endpoint for the store/redact privacy topic (KVKK, required).
- Type
- string
Example
[privacy]
store_redact_url = "…"webhooks
webhooks.subscriptions[].topics
Webhook topics for this subscription. See the Webhook topics page.
- Type
- string array
Example
[[webhooks.subscriptions]]
topics = ["…"]webhooks.subscriptions[].uri
Endpoint URL where this subscription's webhook topics are delivered.
- Type
- string
Example
[[webhooks.subscriptions]]
uri = "…"app_proxy
app_proxy.subpath
Storefront subpath routed to the app: requests under /apps/<subpath> are proxied to your app.
- Type
- string
Example
[app_proxy]
subpath = "…"app_proxy.url
Backend URL where app proxy requests are forwarded.
- Type
- string
Example
[app_proxy]
url = "…"app_proxy.large_responses
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.
- Type
- boolean
Example
[app_proxy]
large_responses = trueapp_proxy.large_responses_reason
Explanation of why large proxy responses are needed; required when large_responses is true, at most 1,000 characters. Shown during review.
- Type
- string
Example
[app_proxy]
large_responses_reason = "…"admin_embedded
admin_embedded.entry_url
URL loaded inside the admin iframe as the app's home page.
- Type
- string
Example
[admin_embedded]
entry_url = "…"admin_embedded.navigation[].label
Display label of a navigation link under the app in the admin.
- Type
- string
Example
[[admin_embedded.navigation]]
label = "…"admin_embedded.navigation[].path
Navigation link path relative to entry_url.
- Type
- string
Example
[[admin_embedded.navigation]]
path = "…"payments_app
payments_app.label
Payment method label shown at checkout.
- Type
- string
Example
[payments_app]
label = "…"payments_app.payment_session_url
Endpoint where payment session requests are sent.
- Type
- string
Example
[payments_app]
payment_session_url = "…"payments_app.refund_session_url
Endpoint where refund requests are sent.
- Type
- string
Example
[payments_app]
refund_session_url = "…"payments_app.capture_session_url
Endpoint where capture requests are sent.
- Type
- string
Example
[payments_app]
capture_session_url = "…"payments_app.void_session_url
Endpoint where void requests are sent.
- Type
- string
Example
[payments_app]
void_session_url = "…"payments_app.supported_currencies
Accepted currency codes (ISO 4217, e.g. TRY).
- Type
- string array
Example
[payments_app]
supported_currencies = ["…"]payments_app.supports_installments
Whether the app supports installment payments.
- Type
- boolean
Example
[payments_app]
supports_installments = truepayments_app.supports_installment_quotes
Whether the app returns dynamic installment options at installment_quote_url; without it, payments are single-charge only.
- Type
- boolean
Example
[payments_app]
supports_installment_quotes = truepayments_app.installment_quote_url
Endpoint queried for installment quote options.
- Type
- string
Example
[payments_app]
installment_quote_url = "…"payments_app.supports_3ds
Whether the app performs 3D Secure verification.
- Type
- boolean
Example
[payments_app]
supports_3ds = truepayments_app.invoice
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.
- Type
- boolean
Example
[payments_app]
invoice = truepayments_app.test_only
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.
- Type
- boolean
Example
[payments_app]
test_only = true