@gofynd/fdk-client-javascript 1.1.2 → 1.1.3

package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts

@@ -3,6 +3,18 @@ declare class Payment {
     constructor(config: any, applicationId: any);
     config: any;
     applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.terminalUniqueIdentifier - Terminal unique identifier
+     * @param {EdcUpdateRequest} arg.body
+     * @returns {Promise<EdcDeviceUpdateResponse>} - Success response
+     * @summary: Update store id and device tag of edc device
+     * @description: Use this API to Update store id and device tag of edc device
+     */
+    addEdcDevice({ terminalUniqueIdentifier, body }?: {
+        terminalUniqueIdentifier: string;
+        body: EdcUpdateRequest;
+    }): Promise<EdcDeviceUpdateResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {AddBeneficiaryDetailsOTPRequest} arg.body
@@ -13,6 +25,26 @@ declare class Payment {
     addRefundBankAccountUsingOTP({ body }?: {
         body: AddBeneficiaryDetailsOTPRequest;
     }): Promise<RefundAccountResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CancelOrResendPaymentLinkRequest} arg.body
+     * @returns {Promise<CancelPaymentLinkResponse>} - Success response
+     * @summary: Cancel payment link
+     * @description: Use this API to cancel a payment link for the customer
+     */
+    cancelPaymentLink({ body }?: {
+        body: CancelOrResendPaymentLinkRequest;
+    }): Promise<CancelPaymentLinkResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PaymentStatusUpdateRequest} arg.body
+     * @returns {Promise<PaymentStatusUpdateResponse>} - Success response
+     * @summary: Performs continuous polling to check status of payment on the server
+     * @description: Use this API to perform continuous polling at intervals to check the status of payment until timeout.
+     */
+    checkAndUpdatePaymentStatus({ body }?: {
+        body: PaymentStatusUpdateRequest;
+    }): Promise<PaymentStatusUpdateResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {PaymentConfirmationRequest} arg.body
@@ -23,6 +55,48 @@ declare class Payment {
     confirmPayment({ body }?: {
         body: PaymentConfirmationRequest;
     }): Promise<PaymentConfirmationResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CreatePaymentLinkRequest} arg.body
+     * @returns {Promise<CreatePaymentLinkResponse>} - Success response
+     * @summary: Create payment link
+     * @description: Use this API to create a payment link for the customer
+     */
+    createPaymentLink({ body }?: {
+        body: CreatePaymentLinkRequest;
+    }): Promise<CreatePaymentLinkResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<EdcAggregatorAndModelListResponse>} - Success response
+     * @summary: get some information about the store and edc device
+     * @description: Use this API to get info of devices linked to a particular app.
+     */
+    edcAggregatorsAndModelList({}?: any): Promise<EdcAggregatorAndModelListResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] -
+     * @param {number} [arg.pageSize] -
+     * @param {boolean} [arg.isActive] -
+     * @param {number} [arg.storeId] -
+     * @param {string} [arg.deviceTag] -
+     * @returns {Promise<EdcDeviceListResponse>} - Success response
+     * @summary: get all the device list of an app
+     * @description: Use this API to get all devices linked to a particular app.
+     */
+    edcDeviceList({ pageNo, pageSize, isActive, storeId, deviceTag }?: {
+        pageNo?: number;
+        pageSize?: number;
+        isActive?: boolean;
+        storeId?: number;
+        deviceTag?: string;
+    }): Promise<EdcDeviceListResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<EdcDeviceStatsResponse>} - Success response
+     * @summary: get some information about the store and edc device
+     * @description: Use this API to get info of devices linked to a particular app.
+     */
+    edcDeviceStats({}?: any): Promise<EdcDeviceStatsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId -
@@ -42,6 +116,33 @@ declare class Payment {
      * @description: Get All Brand Payment Gateway Config Secret
      */
     getBrandPaymentGatewayConfig({}?: any): Promise<PaymentGatewayConfigResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.terminalUniqueIdentifier - Terminal unique identifier
+     * @returns {Promise<EdcDeviceDetailsResponse>} - Success response
+     * @summary: get details of a single edc device
+     * @description: Use this API to get details of a single edc device
+     */
+    getEdcDevice({ terminalUniqueIdentifier }?: {
+        terminalUniqueIdentifier: string;
+    }): Promise<EdcDeviceDetailsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<GetPaymentCodeResponse>} - Success response
+     * @summary: List Payment Options Method Codes
+     * @description: Get all active List Payment Options Method Codes
+     */
+    getPaymentCodeOption({}?: any): Promise<GetPaymentCodeResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.paymentLinkId] -
+     * @returns {Promise<GetPaymentLinkResponse>} - Success response
+     * @summary: Get payment link
+     * @description: Use this API to get a payment link
+     */
+    getPaymentLink({ paymentLinkId }?: {
+        paymentLinkId?: string;
+    }): Promise<GetPaymentLinkResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} arg.refresh -
@@ -54,6 +155,36 @@ declare class Payment {
         refresh: boolean;
         requestType: string;
     }): Promise<PaymentOptionsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.amount - Payable amount.
+     * @param {string} arg.cartId - Identifier of the cart.
+     * @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
+     * @param {string} arg.checkoutMode - Option to checkout for self or for others.
+     * @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
+     *   to remove temporary cache files on payment gateway and replace with the
+     *   latest one.
+     * @param {string} [arg.cardReference] - Card reference id of user's debit
+     *   or credit card.
+     * @param {string} arg.orderType - The order type of shipment * HomeDelivery
+     *   - If the customer wants the order home-delivered * PickAtStore - If the
+     *   customer wants the handover of an order at the store itself.
+     * @param {string} [arg.userDetails] - URIencoded JSON containing details of
+     *   an anonymous user.
+     * @returns {Promise<PaymentOptionsResponse>} - Success response
+     * @summary: Get All Valid Payment Options
+     * @description: Use this API to get Get All Valid Payment Options for making payment
+     */
+    getPosPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, orderType, refresh, cardReference, userDetails, }?: {
+        amount: number;
+        cartId: string;
+        pincode: string;
+        checkoutMode: string;
+        refresh?: boolean;
+        cardReference?: string;
+        orderType: string;
+        userDetails?: string;
+    }): Promise<PaymentOptionsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId -
@@ -86,6 +217,26 @@ declare class Payment {
     getUserOrderBeneficiaries({ orderId }?: {
         orderId: string;
     }): Promise<OrderBeneficiaryResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PaymentInitializationRequest} arg.body
+     * @returns {Promise<PaymentInitializationResponse>} - Success response
+     * @summary: Initialize a payment (server-to-server) for UPI and BharatQR
+     * @description: PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
+     */
+    initialisePayment({ body }?: {
+        body: PaymentInitializationRequest;
+    }): Promise<PaymentInitializationResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {MerchantOnBoardingRequest} arg.body
+     * @returns {Promise<MerchantOnBoardingResponse>} - Success response
+     * @summary: API to push Ajiodhan merchant data to Gringotts system
+     * @description: Use this API to push Ajiodhan merchant data to Gringotts system
+     */
+    merchantOnBoarding({ body }?: {
+        body: MerchantOnBoardingRequest;
+    }): Promise<MerchantOnBoardingResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.aggregator - Aggregator
@@ -100,6 +251,56 @@ declare class Payment {
         successRedirectUrl?: string;
         failureRedirectUrl?: string;
     }): Promise<GetOauthUrlResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {PaymentStatusBulkHandlerRequest} arg.body
+     * @returns {Promise<PaymentStatusBulkHandlerResponse>} - Success response
+     * @summary: Get Payment status and information for a list of order_ids
+     * @description: Use this API to get Payment status and information for a list of order_ids
+     */
+    paymentStatusBulk({ body }?: {
+        body: PaymentStatusBulkHandlerRequest;
+    }): Promise<PaymentStatusBulkHandlerResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.paymentLinkId] -
+     * @returns {Promise<PollingPaymentLinkResponse>} - Success response
+     * @summary: Used for polling if payment successful or not
+     * @description: Use this API to poll if payment through payment was successful or not
+     */
+    pollingPaymentLink({ paymentLinkId }?: {
+        paymentLinkId?: string;
+    }): Promise<PollingPaymentLinkResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {RepaymentDetailsSerialiserPayAll} arg.body
+     * @returns {Promise<RepaymentResponse>} - Success response
+     * @summary: API to register repayment details
+     * @description: Use this API to register any repayment record in the db and notify the aggrgator
+     */
+    repaymentDetails({ body }?: {
+        body: RepaymentDetailsSerialiserPayAll;
+    }): Promise<RepaymentResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {ResendOrCancelPaymentRequest} arg.body
+     * @returns {Promise<ResendOrCancelPaymentResponse>} - Success response
+     * @summary: API to resend and cancel a payment link which was already generated.
+     * @description: Use this API to perform resend or cancel a payment link based on request payload.
+     */
+    resendOrCancelPayment({ body }?: {
+        body: ResendOrCancelPaymentRequest;
+    }): Promise<ResendOrCancelPaymentResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CancelOrResendPaymentLinkRequest} arg.body
+     * @returns {Promise<ResendPaymentLinkResponse>} - Success response
+     * @summary: Resend payment link
+     * @description: Use this API to resend a payment link for the customer
+     */
+    resendPaymentLink({ body }?: {
+        body: CancelOrResendPaymentLinkRequest;
+    }): Promise<ResendPaymentLinkResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.aggregator - Aggregator_slug
@@ -130,4 +331,24 @@ declare class Payment {
     setUserCODlimitRoutes({ body }?: {
         body: SetCODForUserRequest;
     }): Promise<SetCODOptionResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {EdcAddRequest} arg.body
+     * @returns {Promise<EdcDeviceAddResponse>} - Success response
+     * @summary: map new edc device to the terminal
+     * @description: Use this API to map new edc device to the terminal
+     */
+    updateEdcDevice({ body }?: {
+        body: EdcAddRequest;
+    }): Promise<EdcDeviceAddResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {ValidateCustomerRequest} arg.body
+     * @returns {Promise<ValidateCustomerResponse>} - Success response
+     * @summary: Validate customer for payment
+     * @description: Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi.
+     */
+    verifyCustomerForPayment({ body }?: {
+        body: ValidateCustomerRequest;
+    }): Promise<ValidateCustomerResponse>;
 }