diff --git a/src/main/java/com/phonepe/sdk/pg/common/BaseClient.java b/src/main/java/com/phonepe/sdk/pg/common/BaseClient.java index 3e7cb7d..f12e299 100644 --- a/src/main/java/com/phonepe/sdk/pg/common/BaseClient.java +++ b/src/main/java/com/phonepe/sdk/pg/common/BaseClient.java @@ -37,6 +37,17 @@ import okhttp3.OkHttpClient; @Getter +/** + * Abstract base class for all PhonePe Payment Gateway SDK clients. + * + *
Provides shared functionality including OAuth2 token management, + * authenticated HTTP request execution with automatic token refresh, + * and SDK event telemetry publishing.
+ * + * @see com.phonepe.sdk.pg.payments.v2.StandardCheckoutClient + * @see com.phonepe.sdk.pg.payments.v2.CustomCheckoutClient + * @see com.phonepe.sdk.pg.subscription.v2.SubscriptionClient + */ public abstract class BaseClient { private final ObjectMapper objectMapper; diff --git a/src/main/java/com/phonepe/sdk/pg/payments/v2/CustomCheckoutClient.java b/src/main/java/com/phonepe/sdk/pg/payments/v2/CustomCheckoutClient.java index ef5bd16..0bab279 100644 --- a/src/main/java/com/phonepe/sdk/pg/payments/v2/CustomCheckoutClient.java +++ b/src/main/java/com/phonepe/sdk/pg/payments/v2/CustomCheckoutClient.java @@ -50,6 +50,21 @@ import java.util.List; import lombok.SneakyThrows; +/** + * The CustomCheckout client class provides methods for interacting with + * PhonePe's Custom Checkout Payment Gateway APIs. + * + *Use this client when you need full control over the payment experience, + * including direct card/token instrument handling with PCI-compliant routing + * and device OS header injection.
+ * + *For a simpler integration where PhonePe handles the checkout UI, + * use {@link StandardCheckoutClient} instead.
+ * + * @see StandardCheckoutClient + * @see com.phonepe.sdk.pg.subscription.v2.SubscriptionClient + * @see com.phonepe.sdk.pg.common.BaseClient + */ public class CustomCheckoutClient extends BaseClient { private ListUse this client to manage recurring payment mandates, including + * setup, notification, redemption, cancellation, and status queries.
+ * + *For one-time payments, use {@link com.phonepe.sdk.pg.payments.v2.StandardCheckoutClient} + * or {@link com.phonepe.sdk.pg.payments.v2.CustomCheckoutClient} instead.
+ * + * @see com.phonepe.sdk.pg.payments.v2.StandardCheckoutClient + * @see com.phonepe.sdk.pg.payments.v2.CustomCheckoutClient + * @see com.phonepe.sdk.pg.common.BaseClient + */ public class SubscriptionClient extends BaseClient { private List