API Reference

The full Kotlin API reference is generated from source with Dokka and covers every public class, function, and model in the SDK.

Open the generated API reference

Explore by package

• com.digetpay.sdk

  ---

  The DigetPay entry point: checkout, payWithCard, capture, refund, void, recurring, and status lookups.

  DigetPay

• com.digetpay.sdk.config

  ---

  DigetPayConfig and Environment for API keys, environment selection, and logging.

  Config

• com.digetpay.sdk.model

  ---

  Request and result models: CheckoutRequest, CardPaymentRequest, RecurringRequest, PaymentResult, and more.

  Models

• com.digetpay.sdk.callback

  ---

  PaymentCallback and OperationCallback result interfaces.

  Callbacks

Regenerate the reference

The Dokka output is generated from the Kotlin sources, so refresh it whenever the public API changes.

Install the docs dependencies:

python -m pip install -r requirements-docs.txt

Build Dokka and MkDocs together:

.\scripts\build-docs.ps1

Or refresh only the generated API reference files:

./gradlew :digetpay-sdk:syncDokkaToMkDocs

The generated Dokka output is copied into:

docs/api-reference/dokka/