@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/Payment/PaymentApplicationModel.js

@@ -1,23 +1,927 @@
 const Joi = require("joi");
 
-class PaymentModel {
+/**
+ * @typedef ActiveCardPaymentGatewayResponse
+ * @property {CardPaymentGateway} cards - Card's payment gateway with customer id.
+ * @property {string} message - Human readable message.
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef AddBeneficiaryDetailsOTPRequest
+ * @property {BankDetailsForOTP} details
+ * @property {string} order_id
+ */
+
+/**
+ * @typedef AddBeneficiaryDetailsRequest
+ * @property {boolean} delights - True if beneficiary to be added by delights or
+ *   False if by User
+ * @property {BeneficiaryModeDetails} details - Beneficiary bank details
+ * @property {string} order_id - Merchant Order Id
+ * @property {string} [otp]
+ * @property {string} [request_id]
+ * @property {string} shipment_id - Shipment Id of the respective Merchant Order Id
+ * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added
+ */
+
+/**
+ * @typedef AddBeneficiaryViaOtpVerificationRequest
+ * @property {string} hash_key - Hash key of the beneficiary Id
+ * @property {string} otp - Otp sent to the given Mobile No
+ * @property {string} request_id - Request Id sent in
+ */
+
+/**
+ * @typedef AddBeneficiaryViaOtpVerificationResponse
+ * @property {string} message - Aggregator Response of beneficicary
+ * @property {boolean} [success] - Response is successful or not
+ */
+
+/**
+ * @typedef AggregatorConfigDetail
+ * @property {string} [api] - Payment gateway api endpoint
+ * @property {string} config_type - Fynd or self payment gateway
+ * @property {string} key - Payment gateway api key
+ * @property {string} [merchant_id] - Unique merchant id
+ * @property {string} [merchant_key] - Unique merchant key
+ * @property {string} [pin] - Masked pin
+ * @property {boolean} [sdk] - SDK
+ * @property {string} secret - Masked payment gateway api secret
+ * @property {string} [user_id] - Registered User id
+ * @property {string} [verify_api] - Payment gateway verify payment api endpoint
+ */
+
+/**
+ * @typedef AggregatorRoute
+ * @property {string} [api_link] - Api_link
+ * @property {Object} [data] - Data
+ * @property {string} [payment_flow] - Payment_flow
+ * @property {string} [payment_flow_data] - Payment_flow_data
+ */
+
+/**
+ * @typedef AggregatorsConfigDetailResponse
+ * @property {AggregatorConfigDetail} [ccavenue]
+ * @property {string} env - Environment i.e Live or Test
+ * @property {AggregatorConfigDetail} [juspay]
+ * @property {AggregatorConfigDetail} [mswipe]
+ * @property {AggregatorConfigDetail} [payumoney]
+ * @property {AggregatorConfigDetail} [razorpay]
+ * @property {AggregatorConfigDetail} [rupifi]
+ * @property {AggregatorConfigDetail} [simpl]
+ * @property {AggregatorConfigDetail} [stripe]
+ * @property {boolean} success
+ */
+
+/**
+ * @typedef AttachCardRequest
+ * @property {string} card_id - Card token of payment gateway.
+ * @property {string} [name_on_card]
+ * @property {string} [nickname]
+ * @property {boolean} [refresh] - Refresh cache flag.
+ */
+
+/**
+ * @typedef AttachCardsResponse
+ * @property {Object} data - List of cards of customer.
+ * @property {string} [message] - Human readable message.
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef BalanceDetails
+ * @property {string} [currency] - Currency Code
+ * @property {string} [formatted_value] - Formated Amount with currency symbol
+ * @property {number} [value] - Payment amount
+ */
+
+/**
+ * @typedef BankDetailsForOTP
+ * @property {string} account_holder
+ * @property {string} account_no
+ * @property {string} bank_name
+ * @property {string} branch_name
+ * @property {string} ifsc_code
+ */
+
+/**
+ * @typedef BeneficiaryModeDetails
+ * @property {string} account_holder - Name of the Account Holder
+ * @property {string} account_no - Account NUmber of the Account Holder
+ * @property {string} [address] - Address of the User
+ * @property {string} bank_name - Bank Name of the Account
+ * @property {string} branch_name - Branch Name of the Account
+ * @property {string} [comment] - Remarks added by The user
+ * @property {string} email - Email of the Account Holder
+ * @property {string} ifsc_code - Ifsc Code of the Account
+ * @property {string} mobile - Moblie Number of the User
+ * @property {string} [vpa]
+ * @property {string} [wallet]
+ */
+
+/**
+ * @typedef BusinessDetails
+ * @property {KYCAddress} [address] - Address details
+ * @property {string} [business_ownership_type] - Business Ownershipp type(e.g Rented)
+ * @property {string} [business_type] - Business Type
+ * @property {string} [entity_type] - Busineess Entity Type
+ * @property {string} [fda] - Driver License
+ * @property {string} [fssai] - FDA License Number
+ * @property {string} [gstin] - GSTIN Number
+ * @property {string} [name] - Business Name
+ * @property {string} [pan] - Pan Number
+ * @property {Object} [shop_and_establishment] - Shop Establishment
+ * @property {string} [vintage] - Vintage
+ */
+
+/**
+ * @typedef CancelOrResendPaymentLinkRequest
+ * @property {string} payment_link_id - Unique id of payment link
+ */
+
+/**
+ * @typedef CancelPaymentLinkResponse
+ * @property {string} message - Message
+ * @property {number} status_code - HTTP status code
+ * @property {boolean} success - Successful or failure
+ */
+
+/**
+ * @typedef Card
+ * @property {string} aggregator_name - Aggregator_name
+ * @property {string} [card_brand] - Card_brand
+ * @property {string} [card_brand_image] - Card_brand_image
+ * @property {string} [card_fingerprint] - Card_fingerprint
+ * @property {string} [card_id] - Card_id
+ * @property {string} [card_isin] - Card_isin
+ * @property {string} [card_issuer] - Card_issuer
+ * @property {string} [card_name] - Card_name
+ * @property {string} [card_number] - Card_number
+ * @property {string} [card_reference] - Card_reference
+ * @property {string} [card_token] - Card_token
+ * @property {string} [card_type] - Card_type
+ * @property {boolean} [compliant_with_tokenisation_guidelines] - If card is
+ *   tokenised or not
+ * @property {number} [exp_month] - Exp_month
+ * @property {number} [exp_year] - Exp_year
+ * @property {boolean} [expired] - Expired
+ * @property {string} [nickname] - Nickname
+ */
+
+/**
+ * @typedef CardDetails
+ * @property {string} bank - Bank name
+ * @property {string} bank_code - Bank Code
+ * @property {string} card_brand - Card brand like VISA/RUPAY
+ * @property {string} [card_exp_month] - Card Expire Month
+ * @property {string} [card_exp_year] - Card Expire Year
+ * @property {string} card_object - Card bin or Card refrence
+ * @property {string} card_sub_type - Card Sub type
+ * @property {string} [card_token] - Card Token
+ * @property {string} country - Country Name
+ * @property {string} extended_card_type - Extended Card Type
+ * @property {string} id - Id
+ * @property {boolean} is_domestic_card - Is card domestic or international
+ * @property {string} [name_on_card] - Name on Card
+ * @property {boolean} status - Status
+ * @property {string} type - Card Type Credit/Debit
+ * @property {string} [user] - Customer/User ID
+ */
+
+/**
+ * @typedef CardDetailsResponse
+ * @property {CardDetails} data - Saved Card Details
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef CardPaymentGateway
+ * @property {string} aggregator - Payment gateway name.
+ * @property {string} [api] - Payment gateway CARD api endpoint
+ * @property {string} [customer_id] - Payment gateway customer id.
+ */
+
+/**
+ * @typedef ChargeCustomerRequest
+ * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe
+ * @property {number} amount - Chargable amount of order.
+ * @property {string} order_id - Unique order id.
+ * @property {string} [transaction_token] - Transaction token of payment gateway.
+ * @property {boolean} [verified] - Already Verified flag from payment gateway i.e Mswipe
+ */
+
+/**
+ * @typedef ChargeCustomerResponse
+ * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe
+ * @property {string} [cart_id] - Cart id of customer
+ * @property {string} [delivery_address_id] - Delivery adddress id of customer
+ * @property {string} message - Human readable message.
+ * @property {string} order_id - Unique order id.
+ * @property {string} status - Status of charged payment.
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef CheckCreditResponse
+ * @property {CreditDetail} data - Credit summary of user.
+ * @property {boolean} success - Operation is successful or not.
+ */
+
+/**
+ * @typedef CreateOrderUserData
+ * @property {string} [aggregator] - Aggregator name
+ * @property {number} [amount] - Amount
+ * @property {string} [callback_url] - Callback url for aggregator
+ * @property {string} [contact] - Mobile number
+ * @property {string} [currency] - Currency
+ * @property {string} [customer_id] - Aggregator customer id
+ * @property {string} [email] - Email
+ * @property {string} [merchant_order_id] - Merchant order id
+ * @property {string} [method] - Method
+ * @property {string} [order_id] - Aggregator order id
+ */
+
+/**
+ * @typedef CreateOrderUserPaymentMethods
+ * @property {PaymentMethodsMeta} meta - Meta
+ * @property {string} mode - Payment mode
+ * @property {string} name - Payment mode name
+ */
+
+/**
+ * @typedef CreateOrderUserRequest
+ * @property {string} currency - Currency
+ * @property {string} failure_callback_url - Failure page url
+ * @property {Object} [meta] - Meta
+ * @property {string} payment_link_id - Unique id of payment link
+ * @property {CreateOrderUserPaymentMethods} payment_methods - Payment method details
+ * @property {string} success_callback_url - Success page url
+ */
+
+/**
+ * @typedef CreateOrderUserResponse
+ * @property {string} [callback_url] - Callback url for aggregator
+ * @property {CreateOrderUserData} [data]
+ * @property {string} message - Message
+ * @property {string} [order_id] - Merchant order id
+ * @property {string} [payment_confirm_url] - Payment confirm url for aggregator
+ * @property {number} status_code - HTTP status code
+ * @property {boolean} success - Successful or failure
+ */
+
+/**
+ * @typedef CreatePaymentLinkMeta
+ * @property {string} amount
+ * @property {string} [assign_card_id]
+ * @property {string} cart_id
+ * @property {string} checkout_mode
+ * @property {string} pincode
+ */
+
+/**
+ * @typedef CreatePaymentLinkRequest
+ * @property {number} amount - Total value of order
+ * @property {string} [description] - Merchant order id
+ * @property {string} email - Email to which the payment link is to be sent
+ * @property {string} external_order_id - Merchant order id
+ * @property {CreatePaymentLinkMeta} meta - Meta
+ * @property {string} mobile_number - Mobile number to which the payment link is
+ *   to be sent
+ */
+
+/**
+ * @typedef CreatePaymentLinkResponse
+ * @property {string} message - Message
+ * @property {string} [payment_link_id] - Unique id of payment link
+ * @property {string} [payment_link_url] - Url of payment link
+ * @property {number} [polling_timeout] - Polling request timeout
+ * @property {number} status_code - HTTP status code
+ * @property {boolean} success - Successful or failure
+ */
+
+/**
+ * @typedef CreditDetail
+ * @property {boolean} is_registered - User is registered with aggregator or not.
+ * @property {string} signup_url - URL to which the user may redirect.
+ * @property {boolean} status - Operation is successful or not.
+ */
+
+/**
+ * @typedef CreditSummary
+ * @property {BalanceDetails} [amount_available] - Credit summary of user.
+ * @property {BalanceDetails} [balance] - Credit summary of user.
+ * @property {string} [buyer_status] - Status from Credit aggregator's end
+ * @property {string} [credit_line_id] - ID at Credit aggregator's end
+ * @property {string} [merchant_customer_ref_id] - Unique aggregator customer id
+ * @property {string} [status] - Customer Credit status
+ * @property {string} [status_message] - Message to customer
+ */
+
+/**
+ * @typedef CustomerCreditSummaryResponse
+ * @property {CreditSummary} [data] - Credit summary of user.
+ * @property {boolean} success - Payment confirmation updated or not.
+ */
+
+/**
+ * @typedef CustomerOnboardingRequest
+ * @property {string} aggregator - Aggregator Name
+ * @property {BusinessDetails} [business_info] - Business summary.
+ * @property {DeviceDetails} [device] - Device Details.
+ * @property {MarketplaceInfo} [marketplace_info] - Market Place info.
+ * @property {string} [mcc] - Mcc
+ * @property {UserPersonalInfoInDetails} personal_info - Credit summary of user.
+ * @property {string} source - CallbackURL
+ */
+
+/**
+ * @typedef CustomerOnboardingResponse
+ * @property {OnboardSummary} data - Redirect URL.
+ * @property {boolean} success - Status updated or not.
+ */
+
+/**
+ * @typedef DeleteCardsResponse
+ * @property {string} [message] - Human readable message.
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef DeletehCardRequest
+ * @property {string} card_id - Card token of payment gateway.
+ */
+
+/**
+ * @typedef DeviceDetails
+ * @property {string} [device_make] - Device maker
+ * @property {string} [device_model] - Device Model
+ * @property {string} [device_type] - Device Type(E.g. Mobile)
+ * @property {string} [identification_number] - IP
+ * @property {string} [identifier_type] - Static value = ip
+ * @property {string} [os] - OS Name
+ * @property {string} [os_version] - OS Version
+ */
+
+/**
+ * @typedef EpaylaterBannerData
+ * @property {boolean} display - Need to display banner or not
+ * @property {string} [message] - EPayLater message
+ * @property {string} [status] - Epaylater KYC status
+ */
+
+/**
+ * @typedef EpaylaterBannerResponse
+ * @property {EpaylaterBannerData} data - Epaylater KYC banner details.
+ * @property {boolean} success - Successful or not.
+ */
+
+/**
+ * @typedef ErrorCodeAndDescription
+ * @property {string} code - Error descrption code.
+ * @property {string} description - Error human understandable description.
+ */
+
+/**
+ * @typedef ErrorCodeDescription
+ * @property {string} code - Error descrption code.
+ * @property {string} description - Error human understandable description.
+ * @property {boolean} success - Response is successful or not
+ */
+
+/**
+ * @typedef ErrorDescription
+ * @property {number} [amount] - Amount paid
+ * @property {boolean} [cancelled] - Payment link is cancelled or not
+ * @property {boolean} [expired] - Payment link expired or not
+ * @property {boolean} [invalid_id] - Payment link id is valid or not
+ * @property {string} [merchant_name] - Name of merchant that created payment link
+ * @property {string} [merchant_order_id] - Order id
+ * @property {string} [msg] - Message
+ * @property {string} [payment_transaction_id] - Payment transaction id
+ */
+
+/**
+ * @typedef ErrorResponse
+ * @property {ErrorDescription} [error]
+ * @property {string} message - Message
+ * @property {number} status_code - HTTP status code
+ * @property {boolean} success - Successful or failure
+ */
+
+/**
+ * @typedef GetPaymentLinkResponse
+ * @property {number} [amount] - Total value of order
+ * @property {string} [external_order_id] - Merchant order id
+ * @property {string} [merchant_name] - Merchant name
+ * @property {string} message - Message
+ * @property {string} [payment_link_current_status] - Status of payment link
+ * @property {string} [payment_link_url] - Url of payment link
+ * @property {number} [polling_timeout] - Polling request timeout
+ * @property {number} status_code - HTTP status code
+ * @property {boolean} success - Successful or failure
+ */
+
+/**
+ * @typedef HttpErrorCodeAndResponse
+ * @property {ErrorCodeAndDescription} error
+ * @property {boolean} success - Response is successful or not
+ */
+
+/**
+ * @typedef IfscCodeResponse
+ * @property {string} bank_name - Bank Name Of Account
+ * @property {string} branch_name - Branch Name Of Account
+ * @property {boolean} [success] - Response is successful or not
+ */
+
+/**
+ * @typedef IntentApp
+ * @property {string} [code] - Code
+ * @property {string} [display_name] - Display_name
+ * @property {PaymentModeLogo} [logos] - Logos
+ * @property {string} [package_name] - Package_name
+ */
+
+/**
+ * @typedef IntentAppErrorList
+ * @property {string} [code] - Code
+ * @property {string} [package_name] - Package_name
+ */
+
+/**
+ * @typedef KYCAddress
+ * @property {string} addressline1 - Address Line 1
+ * @property {string} [addressline2] - Address Line 2
+ * @property {string} city - City
+ * @property {string} [land_mark] - Land Mark
+ * @property {string} [ownership_type] - Address Owner Type
+ * @property {string} pincode - Pincode
+ * @property {string} state - State
+ */
+
+/**
+ * @typedef LinkStatus
+ * @property {string} message - Message
+ * @property {boolean} status - Link action status
+ */
+
+/**
+ * @typedef ListCardsResponse
+ * @property {Card[]} [data] - List of cards of customer.
+ * @property {string} message - Human readable message.
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef MarketplaceInfo
+ * @property {string} [date_of_joining] - Date of joining
+ * @property {string} membership_id - Merchant id
+ * @property {string} name - Name of store
+ */
+
+/**
+ * @typedef NotFoundResourceError
+ * @property {string} code - Bad Request Data
+ * @property {string} description - Not Found
+ * @property {boolean} success - Response is successful or not
+ */
+
+/**
+ * @typedef OnboardSummary
+ * @property {string} redirect_url - URL to which the user may redirect.
+ * @property {Object} session - User Session
+ * @property {boolean} status - Operation Status
+ */
+
+/**
+ * @typedef OrderBeneficiaryDetails
+ * @property {string} account_holder - Account Holder Name
+ * @property {string} account_no - Account Number
+ * @property {string} address - Address of User
+ * @property {string} bank_name - Bank Name Of Account
+ * @property {string} beneficiary_id - Benenficiary Id
+ * @property {string} [branch_name] - Branch Name Of Account
+ * @property {string} [comment] - Remarks
+ * @property {string} created_on - Creation Date of Beneficiary
+ * @property {string} [delights_user_name] - User Id Who filled the Beneficiary
+ * @property {string} display_name - Display Name Of Account
+ * @property {string} email - EMail of User
+ * @property {number} id -
+ * @property {string} ifsc_code - Ifsc Code Of Account
+ * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not
+ * @property {string} [mobile] - MObile no of User
+ * @property {string} modified_on - MOdification Date of Beneficiary
+ * @property {string} subtitle - SHort Title Of Account
+ * @property {string} title - Title Of Account
+ * @property {string} transfer_mode - Transfer Mode Of Account
+ */
+
+/**
+ * @typedef OrderBeneficiaryResponse
+ * @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order
+ * @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
+ */
+
+/**
+ * @typedef OutstandingOrderDetailsResponse
+ * @property {Object[]} [data] - Dict containing the outstanding order details
+ * @property {string} [message] - Message
+ * @property {number} status_code - HTTP Status code
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef PaidOrderDetailsResponse
+ * @property {Object[]} [data] - Dict containing the paid order details
+ * @property {string} [message] - Message
+ * @property {number} status_code - HTTP Status code
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef PaymentFlow
+ * @property {AggregatorRoute} [ajiodhan] - Ajiodhan
+ * @property {AggregatorRoute} [bqr_razorpay] - BQR_Razorpay
+ * @property {AggregatorRoute} [ccavenue] - Ccavenue
+ * @property {AggregatorRoute} [epaylater] - Epaylater
+ * @property {AggregatorRoute} [fynd] - Fynd
+ * @property {AggregatorRoute} [jiopay] - Jiopay
+ * @property {AggregatorRoute} [juspay] - Juspay
+ * @property {AggregatorRoute} [mswipe] - Mswipe
+ * @property {AggregatorRoute} [payubiz] - Payubiz
+ * @property {AggregatorRoute} [razorpay] - Razorpay
+ * @property {AggregatorRoute} [rupifi] - Rupifi
+ * @property {AggregatorRoute} [simpl] - Simpl
+ * @property {AggregatorRoute} [stripe] - Stripe
+ * @property {AggregatorRoute} [upi_razorpay] - UPI_Razorpay
+ */
+
+/**
+ * @typedef PaymentInitializationRequest
+ * @property {string} aggregator - Payment gateway name
+ * @property {number} amount - Payable amount.
+ * @property {string} contact - Customer valid mobile number
+ * @property {string} currency - Currency code.
+ * @property {string} customer_id - Payment gateway customer id.
+ * @property {string} [device_id] - EDC machine Unique Identifier
+ * @property {string} email - Customer valid email
+ * @property {string} merchant_order_id - Unique fynd order id
+ * @property {string} method - Payment method
+ * @property {string} order_id - Payment gateway order id
+ * @property {string} [razorpay_payment_id] - Payment gateway payment id
+ * @property {number} [timeout] - Payment polling timeout if not recieved response
+ * @property {string} [vpa] - Customer vpa address
+ */
+
+/**
+ * @typedef PaymentInitializationResponse
+ * @property {string} aggregator - Payment gateway name
+ * @property {string} [aggregator_order_id] - Payment order id
+ * @property {number} [amount] - Payable amount.
+ * @property {string} [bqr_image] - Bharath qr image url.
+ * @property {string} [currency] - Currency code.
+ * @property {string} [customer_id] - Payment gateway customer id.
+ * @property {string} [device_id] - EDC machine Unique Identifier
+ * @property {string} merchant_order_id - Order id
+ * @property {string} method - Payment method
+ * @property {string} polling_url - Polling url.
+ * @property {string} [razorpay_payment_id] - Payment id.
+ * @property {string} [status] - Status of payment.
+ * @property {boolean} success - Response is successful or not.
+ * @property {number} [timeout] - Timeout.
+ * @property {string} [upi_poll_url] - UPI poll url.
+ * @property {string} [virtual_id] - Payment virtual address.
+ * @property {string} [vpa] - Customer vpa address
+ */
+
+/**
+ * @typedef PaymentMethodsMeta
+ * @property {string} merchant_code - Merchant code
+ * @property {string} payment_gateway - Payment gateway name
+ * @property {string} payment_identifier - Payment identifier
+ */
+
+/**
+ * @typedef PaymentModeList
+ * @property {string} aggregator_name - Aggregator_name
+ * @property {string} [card_brand] - Card_brand
+ * @property {string} [card_brand_image] - Card_brand_image
+ * @property {string} [card_fingerprint] - Card_fingerprint
+ * @property {string} [card_id] - Card_id
+ * @property {string} [card_isin] - Card_isin
+ * @property {string} [card_issuer] - Card_issuer
+ * @property {string} [card_name] - Card_name
+ * @property {string} [card_number] - Card_number
+ * @property {string} [card_reference] - Card_reference
+ * @property {string} [card_token] - Card_token
+ * @property {string} [card_type] - Card_type
+ * @property {number} [cod_limit] - Cod limit
+ * @property {number} [cod_limit_per_order] - Cod limit per order
+ * @property {string} [code] - Code
+ * @property {boolean} [compliant_with_tokenisation_guidelines] - If card is
+ *   tokenised or not
+ * @property {string} [display_name] - Display name
+ * @property {number} [display_priority] - Dispaly Priority
+ * @property {number} [exp_month] - Exp_month
+ * @property {number} [exp_year] - Exp_year
+ * @property {boolean} [expired] - Expired
+ * @property {string} [fynd_vpa] - Fynd_vpa
+ * @property {IntentApp[]} [intent_app] - Intent_app
+ * @property {IntentAppErrorList[]} [intent_app_error_dict_list] -
+ *   Intent_app_error_dict_list
+ * @property {string[]} [intent_app_error_list] - Intent_app_error_list
+ * @property {boolean} [intent_flow] - Intent_flow
+ * @property {PaymentModeLogo} [logo_url] - Logo
+ * @property {string} [merchant_code] - Merchant code
+ * @property {string} [name] - Name
+ * @property {string} [nickname] - Nickname
+ * @property {number} [remaining_limit] - Remaining limit
+ * @property {number} [retry_count] - Retry_count
+ * @property {number} [timeout] - Timeout
+ */
+
+/**
+ * @typedef PaymentModeLogo
+ * @property {string} large - Large
+ * @property {string} small - Smalll
+ */
+
+/**
+ * @typedef PaymentModeRouteResponse
+ * @property {PaymentOptionAndFlow} payment_options - Payment_options
+ * @property {boolean} success - Response is successful or not
+ */
+
+/**
+ * @typedef PaymentOptionAndFlow
+ * @property {PaymentFlow} payment_flows - Payment_flows
+ * @property {RootPaymentMode[]} payment_option - Payment options
+ */
+
+/**
+ * @typedef PaymentStatusUpdateRequest
+ * @property {string} aggregator - Payment gateway name
+ * @property {number} amount - Payable amount.
+ * @property {string} contact - Customer valid mobile number
+ * @property {string} currency - Currency code.
+ * @property {string} customer_id - Payment gateway customer id.
+ * @property {string} [device_id] - EDC machine Unique Identifier
+ * @property {string} email - Customer valid email
+ * @property {string} merchant_order_id - Unique fynd order id
+ * @property {string} merchant_transaction_id - Unique fynd transaction id
+ * @property {string} method - Payment method
+ * @property {string} order_id - Payment gateway order id
+ * @property {string} status - Status of payment.
+ * @property {string} [vpa] - Customer vpa address
+ */
+
+/**
+ * @typedef PaymentStatusUpdateResponse
+ * @property {string} aggregator_name - Payment gateway name
+ * @property {string} [redirect_url] - Redirect url
+ * @property {boolean} retry - Response is successful or not.
+ * @property {string} status - Payment status
+ * @property {boolean} [success] - Response is successful or not
+ */
+
+/**
+ * @typedef PollingPaymentLinkResponse
+ * @property {string} [aggregator_name] - Aggregator name
+ * @property {number} [amount] - Amount
+ * @property {number} [http_status] - HTTP status code
+ * @property {string} [message] - Message
+ * @property {string} [order_id] - Fynd order id
+ * @property {string} [payment_link_id] - Payment link id
+ * @property {string} [redirect_url] - Url to redirect to
+ * @property {string} [status] - Status of payment link
+ * @property {number} [status_code] - HTTP status code
+ * @property {boolean} [success] - Successful or failure
+ */
+
+/**
+ * @typedef RedirectToAggregatorResponse
+ * @property {RedirectURL} data - Redirect URL.
+ * @property {boolean} success - Status updated or not.
+ */
+
+/**
+ * @typedef RedirectURL
+ * @property {string} signup_url - URL to which the user may redirect.
+ * @property {boolean} status - Aggregator's Operation is successful or not.
+ */
+
+/**
+ * @typedef RefundAccountResponse
+ * @property {Object} [data] - Refund account data.
+ * @property {boolean} [is_verified_flag]
+ * @property {string} message - Response message
+ * @property {boolean} success - Success or failure flag.
+ */
+
+/**
+ * @typedef renderHTMLRequest
+ * @property {string} base64_html - Base64 encoded html string
+ * @property {string} [returntype] - Return Type of API
+ */
+
+/**
+ * @typedef renderHTMLResponse
+ * @property {string} html - HTML string
+ */
+
+/**
+ * @typedef ResendOrCancelPaymentRequest
+ * @property {string} [device_id] - EDC machine Unique Identifier
+ * @property {string} order_id - Unique order id
+ * @property {string} request_type - Either resend or cancel
+ */
+
+/**
+ * @typedef ResendOrCancelPaymentResponse
+ * @property {LinkStatus} data - Data about link action status.
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef ResendPaymentLinkResponse
+ * @property {string} message - Message
+ * @property {number} [polling_timeout] - Polling request timeout
+ * @property {number} status_code - HTTP status code
+ * @property {boolean} success - Successful or failure
+ */
+
+/**
+ * @typedef RootPaymentMode
+ * @property {boolean} [add_card_enabled] - Annonymous card flag
+ * @property {string} [aggregator_name] - Dispaly Priority
+ * @property {boolean} [anonymous_enable] - Annonymous card flag
+ * @property {string} display_name - Payment mode display name
+ * @property {number} display_priority - Dispaly Priority
+ * @property {boolean} [is_pay_by_card_pl] - This flag will be true in case of
+ *   Payment link payment through card
+ * @property {PaymentModeList[]} [list] - Payment mode
+ * @property {string} name - Payment mode name
+ * @property {boolean} [save_card] - Card save or not
+ */
+
+/**
+ * @typedef RupifiBannerData
+ * @property {string} [kyc_url] - Rupifi KYC banner url.
+ * @property {string} [status] - Rupifi KYC status
+ */
+
+/**
+ * @typedef RupifiBannerResponse
+ * @property {RupifiBannerData} data - Rupifi KYC banner details.
+ * @property {boolean} success - Successful or not.
+ */
+
+/**
+ * @typedef SetDefaultBeneficiaryRequest
+ * @property {string} beneficiary_id - Beneficiary Hash Id of the beneficiary added
+ * @property {string} order_id - Merchant Order Id
+ */
+
+/**
+ * @typedef SetDefaultBeneficiaryResponse
+ * @property {boolean} is_beneficiary_set - Boolean Flag whether Beneficiary set or not
+ * @property {boolean} [success] - Response is successful or not
+ */
+
+/**
+ * @typedef TransferItemsDetails
+ * @property {string} [display_name] - Beneficiary Display Name
+ * @property {number} id -
+ * @property {string} logo_large - Beneficiary large Logo
+ * @property {string} logo_small - Beneficiary small Logo
+ * @property {string} name - Beneficiary Name
+ */
+
+/**
+ * @typedef TransferModeDetails
+ * @property {string} display_name - Beneficiary Mode Name
+ * @property {TransferItemsDetails[]} [items] - Beneficiary Mode Items
+ */
+
+/**
+ * @typedef TransferModeResponse
+ * @property {TransferModeDetails[]} data - Response Object
+ */
+
+/**
+ * @typedef UpdateRefundTransferModeRequest
+ * @property {boolean} enable - True for enabling the Transfer Mode
+ * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added
+ */
+
+/**
+ * @typedef UpdateRefundTransferModeResponse
+ * @property {boolean} [success] - Response is successful or not
+ */
+
+/**
+ * @typedef UserPersonalInfoInDetails
+ * @property {KYCAddress} address_as_per_id - Address details
+ * @property {string} dob - DOB
+ * @property {string} [driving_license] - Driver License
+ * @property {string} [email] - Email
+ * @property {boolean} email_verified - Is Email Verified or not
+ * @property {string} [fathers_name] - Father's Name
+ * @property {string} first_name - First Name
+ * @property {string} [gender] - Gender
+ * @property {string} [last_name] - Last Name
+ * @property {string} [middle_name] - Middle Name
+ * @property {boolean} mobile_verified - Is Mobile Verified or not
+ * @property {string} [mothers_name] - Mother's Name
+ * @property {string} [pan] - Pan Number
+ * @property {string} [passport] - Passport
+ * @property {string} phone - Email
+ * @property {string} [voter_id] - Voter ID Number
+ */
+
+/**
+ * @typedef ValidateCustomerRequest
+ * @property {string} aggregator - Payment gateway name in camel case i.e Simpl, Rupifi
+ * @property {Object} [billing_address] - Extra meta fields.
+ * @property {Object} [delivery_address] - Extra meta fields.
+ * @property {Object} [merchant_params] - Extra meta fields.
+ * @property {Object[]} [order_items] - Extra meta fields.
+ * @property {string} [payload] - Hashed payload string.
+ * @property {string} phone_number - User mobile number without country code.
+ * @property {number} transaction_amount_in_paise - Payable amount in paise
+ */
+
+/**
+ * @typedef ValidateCustomerResponse
+ * @property {Object} data - Payment gateway response data
+ * @property {string} message - Error or success message.
+ * @property {boolean} success - Response is successful or not
+ */
+
+/**
+ * @typedef ValidateUPI
+ * @property {string} customer_name - Customer Bank
+ * @property {boolean} is_valid - Boolean is true or false.
+ * @property {string} status - VALID or INVALID
+ * @property {string} upi_vpa - UPI ID
+ */
+
+/**
+ * @typedef ValidateVPARequest
+ * @property {string} upi_vpa - UPI ID
+ */
+
+/**
+ * @typedef ValidateVPAResponse
+ * @property {ValidateUPI} data - Data about UPI ID validate.
+ * @property {boolean} success - Response is successful or not.
+ */
+
+/**
+ * @typedef WalletOtpRequest
+ * @property {string} country_code - Country Code of the Mobile Number
+ * @property {string} mobile - Wallet Moblie Number of the User
+ */
+
+/**
+ * @typedef WalletOtpResponse
+ * @property {string} is_verified_flag - Boolean Flag whether OTP Validation is
+ *   already done or not
+ * @property {string} request_id - Request id
+ * @property {boolean} [success] - Response is successful or not
+ */
+
+/**
+ * @typedef WrongOtpError
+ * @property {string} description - Wrong OTP Code
+ * @property {boolean} is_verified_flag - Vefified flag.
+ * @property {string} success - Response is successful or not
+ */
+
+class PaymentApplicationModel {
+  /** @returns {ActiveCardPaymentGatewayResponse} */
   static ActiveCardPaymentGatewayResponse() {
     return Joi.object({
-      cards: PaymentModel.CardPaymentGateway().required(),
+      cards: PaymentApplicationModel.CardPaymentGateway().required(),
       message: Joi.string().allow("").required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {AddBeneficiaryDetailsOTPRequest} */
   static AddBeneficiaryDetailsOTPRequest() {
     return Joi.object({
-      details: PaymentModel.BankDetailsForOTP().required(),
+      details: PaymentApplicationModel.BankDetailsForOTP().required(),
       order_id: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {AddBeneficiaryDetailsRequest} */
   static AddBeneficiaryDetailsRequest() {
     return Joi.object({
       delights: Joi.boolean().required(),
-      details: PaymentModel.BeneficiaryModeDetails().required(),
+      details: PaymentApplicationModel.BeneficiaryModeDetails().required(),
       order_id: Joi.string().allow("").required(),
       otp: Joi.string().allow(""),
       request_id: Joi.string().allow(""),
@@ -25,6 +929,8 @@ class PaymentModel {
       transfer_mode: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {AddBeneficiaryViaOtpVerificationRequest} */
   static AddBeneficiaryViaOtpVerificationRequest() {
     return Joi.object({
       hash_key: Joi.string().allow("").required(),
@@ -32,12 +938,16 @@ class PaymentModel {
       request_id: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {AddBeneficiaryViaOtpVerificationResponse} */
   static AddBeneficiaryViaOtpVerificationResponse() {
     return Joi.object({
       message: Joi.string().allow("").required(),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {AggregatorConfigDetail} */
   static AggregatorConfigDetail() {
     return Joi.object({
       api: Joi.string().allow("").allow(null),
@@ -52,6 +962,8 @@ class PaymentModel {
       verify_api: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {AggregatorRoute} */
   static AggregatorRoute() {
     return Joi.object({
       api_link: Joi.string().allow("").allow(null),
@@ -60,20 +972,24 @@ class PaymentModel {
       payment_flow_data: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {AggregatorsConfigDetailResponse} */
   static AggregatorsConfigDetailResponse() {
     return Joi.object({
-      ccavenue: PaymentModel.AggregatorConfigDetail(),
+      ccavenue: PaymentApplicationModel.AggregatorConfigDetail(),
       env: Joi.string().allow("").required(),
-      juspay: PaymentModel.AggregatorConfigDetail(),
-      mswipe: PaymentModel.AggregatorConfigDetail(),
-      payumoney: PaymentModel.AggregatorConfigDetail(),
-      razorpay: PaymentModel.AggregatorConfigDetail(),
-      rupifi: PaymentModel.AggregatorConfigDetail(),
-      simpl: PaymentModel.AggregatorConfigDetail(),
-      stripe: PaymentModel.AggregatorConfigDetail(),
+      juspay: PaymentApplicationModel.AggregatorConfigDetail(),
+      mswipe: PaymentApplicationModel.AggregatorConfigDetail(),
+      payumoney: PaymentApplicationModel.AggregatorConfigDetail(),
+      razorpay: PaymentApplicationModel.AggregatorConfigDetail(),
+      rupifi: PaymentApplicationModel.AggregatorConfigDetail(),
+      simpl: PaymentApplicationModel.AggregatorConfigDetail(),
+      stripe: PaymentApplicationModel.AggregatorConfigDetail(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {AttachCardRequest} */
   static AttachCardRequest() {
     return Joi.object({
       card_id: Joi.string().allow("").allow(null).required(),
@@ -82,6 +998,8 @@ class PaymentModel {
       refresh: Joi.boolean().allow(null),
     });
   }
+
+  /** @returns {AttachCardsResponse} */
   static AttachCardsResponse() {
     return Joi.object({
       data: Joi.any().required(),
@@ -89,6 +1007,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {BalanceDetails} */
   static BalanceDetails() {
     return Joi.object({
       currency: Joi.string().allow("").allow(null),
@@ -96,6 +1016,8 @@ class PaymentModel {
       value: Joi.number().allow(null),
     });
   }
+
+  /** @returns {BankDetailsForOTP} */
   static BankDetailsForOTP() {
     return Joi.object({
       account_holder: Joi.string().allow("").required(),
@@ -105,6 +1027,8 @@ class PaymentModel {
       ifsc_code: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {BeneficiaryModeDetails} */
   static BeneficiaryModeDetails() {
     return Joi.object({
       account_holder: Joi.string().allow("").required(),
@@ -120,9 +1044,11 @@ class PaymentModel {
       wallet: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {BusinessDetails} */
   static BusinessDetails() {
     return Joi.object({
-      address: PaymentModel.KYCAddress(),
+      address: PaymentApplicationModel.KYCAddress(),
       business_ownership_type: Joi.string().allow("").allow(null),
       business_type: Joi.string().allow("").allow(null),
       entity_type: Joi.string().allow("").allow(null),
@@ -135,11 +1061,15 @@ class PaymentModel {
       vintage: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {CancelOrResendPaymentLinkRequest} */
   static CancelOrResendPaymentLinkRequest() {
     return Joi.object({
       payment_link_id: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CancelPaymentLinkResponse} */
   static CancelPaymentLinkResponse() {
     return Joi.object({
       message: Joi.string().allow("").required(),
@@ -147,6 +1077,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {Card} */
   static Card() {
     return Joi.object({
       aggregator_name: Joi.string().allow("").required(),
@@ -168,6 +1100,8 @@ class PaymentModel {
       nickname: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {CardDetails} */
   static CardDetails() {
     return Joi.object({
       bank: Joi.string().allow("").required(),
@@ -188,12 +1122,16 @@ class PaymentModel {
       user: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CardDetailsResponse} */
   static CardDetailsResponse() {
     return Joi.object({
-      data: PaymentModel.CardDetails().required(),
+      data: PaymentApplicationModel.CardDetails().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CardPaymentGateway} */
   static CardPaymentGateway() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -201,6 +1139,8 @@ class PaymentModel {
       customer_id: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {ChargeCustomerRequest} */
   static ChargeCustomerRequest() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -210,6 +1150,8 @@ class PaymentModel {
       verified: Joi.boolean().allow(null),
     });
   }
+
+  /** @returns {ChargeCustomerResponse} */
   static ChargeCustomerResponse() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -221,12 +1163,16 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CheckCreditResponse} */
   static CheckCreditResponse() {
     return Joi.object({
-      data: PaymentModel.CreditDetail().required(),
+      data: PaymentApplicationModel.CreditDetail().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CreateOrderUserData} */
   static CreateOrderUserData() {
     return Joi.object({
       aggregator: Joi.string().allow("").allow(null),
@@ -241,27 +1187,33 @@ class PaymentModel {
       order_id: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {CreateOrderUserPaymentMethods} */
   static CreateOrderUserPaymentMethods() {
     return Joi.object({
-      meta: PaymentModel.PaymentMethodsMeta().required(),
+      meta: PaymentApplicationModel.PaymentMethodsMeta().required(),
       mode: Joi.string().allow("").required(),
       name: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CreateOrderUserRequest} */
   static CreateOrderUserRequest() {
     return Joi.object({
       currency: Joi.string().allow("").required(),
       failure_callback_url: Joi.string().allow("").required(),
       meta: Joi.any().allow(null),
       payment_link_id: Joi.string().allow("").required(),
-      payment_methods: PaymentModel.CreateOrderUserPaymentMethods().required(),
+      payment_methods: PaymentApplicationModel.CreateOrderUserPaymentMethods().required(),
       success_callback_url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CreateOrderUserResponse} */
   static CreateOrderUserResponse() {
     return Joi.object({
       callback_url: Joi.string().allow("").allow(null),
-      data: PaymentModel.CreateOrderUserData(),
+      data: PaymentApplicationModel.CreateOrderUserData(),
       message: Joi.string().allow("").required(),
       order_id: Joi.string().allow("").allow(null),
       payment_confirm_url: Joi.string().allow("").allow(null),
@@ -269,6 +1221,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CreatePaymentLinkMeta} */
   static CreatePaymentLinkMeta() {
     return Joi.object({
       amount: Joi.string().allow("").required(),
@@ -278,16 +1232,20 @@ class PaymentModel {
       pincode: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CreatePaymentLinkRequest} */
   static CreatePaymentLinkRequest() {
     return Joi.object({
       amount: Joi.number().required(),
       description: Joi.string().allow("").allow(null),
       email: Joi.string().allow("").required(),
       external_order_id: Joi.string().allow("").required(),
-      meta: PaymentModel.CreatePaymentLinkMeta().required(),
+      meta: PaymentApplicationModel.CreatePaymentLinkMeta().required(),
       mobile_number: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CreatePaymentLinkResponse} */
   static CreatePaymentLinkResponse() {
     return Joi.object({
       message: Joi.string().allow("").required(),
@@ -298,6 +1256,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CreditDetail} */
   static CreditDetail() {
     return Joi.object({
       is_registered: Joi.boolean().required(),
@@ -305,10 +1265,12 @@ class PaymentModel {
       status: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CreditSummary} */
   static CreditSummary() {
     return Joi.object({
-      amount_available: PaymentModel.BalanceDetails(),
-      balance: PaymentModel.BalanceDetails(),
+      amount_available: PaymentApplicationModel.BalanceDetails(),
+      balance: PaymentApplicationModel.BalanceDetails(),
       buyer_status: Joi.string().allow("").allow(null),
       credit_line_id: Joi.string().allow("").allow(null),
       merchant_customer_ref_id: Joi.string().allow("").allow(null),
@@ -316,40 +1278,52 @@ class PaymentModel {
       status_message: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {CustomerCreditSummaryResponse} */
   static CustomerCreditSummaryResponse() {
     return Joi.object({
-      data: PaymentModel.CreditSummary(),
+      data: PaymentApplicationModel.CreditSummary(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CustomerOnboardingRequest} */
   static CustomerOnboardingRequest() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
-      business_info: PaymentModel.BusinessDetails(),
-      device: PaymentModel.DeviceDetails(),
-      marketplace_info: PaymentModel.MarketplaceInfo(),
+      business_info: PaymentApplicationModel.BusinessDetails(),
+      device: PaymentApplicationModel.DeviceDetails(),
+      marketplace_info: PaymentApplicationModel.MarketplaceInfo(),
       mcc: Joi.string().allow("").allow(null),
-      personal_info: PaymentModel.UserPersonalInfoInDetails().required(),
+      personal_info: PaymentApplicationModel.UserPersonalInfoInDetails().required(),
       source: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CustomerOnboardingResponse} */
   static CustomerOnboardingResponse() {
     return Joi.object({
-      data: PaymentModel.OnboardSummary().required(),
+      data: PaymentApplicationModel.OnboardSummary().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {DeleteCardsResponse} */
   static DeleteCardsResponse() {
     return Joi.object({
       message: Joi.string().allow("").allow(null),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {DeletehCardRequest} */
   static DeletehCardRequest() {
     return Joi.object({
       card_id: Joi.string().allow("").allow(null).required(),
     });
   }
+
+  /** @returns {DeviceDetails} */
   static DeviceDetails() {
     return Joi.object({
       device_make: Joi.string().allow("").allow(null),
@@ -361,6 +1335,8 @@ class PaymentModel {
       os_version: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {EpaylaterBannerData} */
   static EpaylaterBannerData() {
     return Joi.object({
       display: Joi.boolean().required(),
@@ -368,18 +1344,24 @@ class PaymentModel {
       status: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EpaylaterBannerResponse} */
   static EpaylaterBannerResponse() {
     return Joi.object({
-      data: PaymentModel.EpaylaterBannerData().required(),
+      data: PaymentApplicationModel.EpaylaterBannerData().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {ErrorCodeAndDescription} */
   static ErrorCodeAndDescription() {
     return Joi.object({
       code: Joi.string().allow("").required(),
       description: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ErrorCodeDescription} */
   static ErrorCodeDescription() {
     return Joi.object({
       code: Joi.string().allow("").required(),
@@ -387,6 +1369,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {ErrorDescription} */
   static ErrorDescription() {
     return Joi.object({
       amount: Joi.number().allow(null),
@@ -399,14 +1383,18 @@ class PaymentModel {
       payment_transaction_id: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {ErrorResponse} */
   static ErrorResponse() {
     return Joi.object({
-      error: PaymentModel.ErrorDescription(),
+      error: PaymentApplicationModel.ErrorDescription(),
       message: Joi.string().allow("").required(),
       status_code: Joi.number().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {GetPaymentLinkResponse} */
   static GetPaymentLinkResponse() {
     return Joi.object({
       amount: Joi.number().allow(null),
@@ -420,12 +1408,16 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {HttpErrorCodeAndResponse} */
   static HttpErrorCodeAndResponse() {
     return Joi.object({
-      error: PaymentModel.ErrorCodeAndDescription().required(),
+      error: PaymentApplicationModel.ErrorCodeAndDescription().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {IfscCodeResponse} */
   static IfscCodeResponse() {
     return Joi.object({
       bank_name: Joi.string().allow("").required(),
@@ -433,20 +1425,26 @@ class PaymentModel {
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {IntentApp} */
   static IntentApp() {
     return Joi.object({
       code: Joi.string().allow("").allow(null),
       display_name: Joi.string().allow("").allow(null),
-      logos: PaymentModel.PaymentModeLogo(),
+      logos: PaymentApplicationModel.PaymentModeLogo(),
       package_name: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {IntentAppErrorList} */
   static IntentAppErrorList() {
     return Joi.object({
       code: Joi.string().allow("").allow(null),
       package_name: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {KYCAddress} */
   static KYCAddress() {
     return Joi.object({
       addressline1: Joi.string().allow("").required(),
@@ -458,19 +1456,25 @@ class PaymentModel {
       state: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {LinkStatus} */
   static LinkStatus() {
     return Joi.object({
       message: Joi.string().allow("").required(),
       status: Joi.boolean().required(),
     });
   }
+
+  /** @returns {ListCardsResponse} */
   static ListCardsResponse() {
     return Joi.object({
-      data: Joi.array().items(PaymentModel.Card()),
+      data: Joi.array().items(PaymentApplicationModel.Card()),
       message: Joi.string().allow("").required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {MarketplaceInfo} */
   static MarketplaceInfo() {
     return Joi.object({
       date_of_joining: Joi.string().allow("").allow(null),
@@ -478,6 +1482,8 @@ class PaymentModel {
       name: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {NotFoundResourceError} */
   static NotFoundResourceError() {
     return Joi.object({
       code: Joi.string().allow("").required(),
@@ -485,6 +1491,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {OnboardSummary} */
   static OnboardSummary() {
     return Joi.object({
       redirect_url: Joi.string().allow("").required(),
@@ -492,6 +1500,8 @@ class PaymentModel {
       status: Joi.boolean().required(),
     });
   }
+
+  /** @returns {OrderBeneficiaryDetails} */
   static OrderBeneficiaryDetails() {
     return Joi.object({
       account_holder: Joi.string().allow("").required(),
@@ -515,12 +1525,18 @@ class PaymentModel {
       transfer_mode: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {OrderBeneficiaryResponse} */
   static OrderBeneficiaryResponse() {
     return Joi.object({
-      beneficiaries: Joi.array().items(PaymentModel.OrderBeneficiaryDetails()),
+      beneficiaries: Joi.array().items(
+        PaymentApplicationModel.OrderBeneficiaryDetails()
+      ),
       show_beneficiary_details: Joi.boolean(),
     });
   }
+
+  /** @returns {OutstandingOrderDetailsResponse} */
   static OutstandingOrderDetailsResponse() {
     return Joi.object({
       data: Joi.array().items(Joi.any()),
@@ -529,6 +1545,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {PaidOrderDetailsResponse} */
   static PaidOrderDetailsResponse() {
     return Joi.object({
       data: Joi.array().items(Joi.any()),
@@ -537,24 +1555,28 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {PaymentFlow} */
   static PaymentFlow() {
     return Joi.object({
-      ajiodhan: PaymentModel.AggregatorRoute(),
-      bqr_razorpay: PaymentModel.AggregatorRoute(),
-      ccavenue: PaymentModel.AggregatorRoute(),
-      epaylater: PaymentModel.AggregatorRoute(),
-      fynd: PaymentModel.AggregatorRoute(),
-      jiopay: PaymentModel.AggregatorRoute(),
-      juspay: PaymentModel.AggregatorRoute(),
-      mswipe: PaymentModel.AggregatorRoute(),
-      payubiz: PaymentModel.AggregatorRoute(),
-      razorpay: PaymentModel.AggregatorRoute(),
-      rupifi: PaymentModel.AggregatorRoute(),
-      simpl: PaymentModel.AggregatorRoute(),
-      stripe: PaymentModel.AggregatorRoute(),
-      upi_razorpay: PaymentModel.AggregatorRoute(),
+      ajiodhan: PaymentApplicationModel.AggregatorRoute(),
+      bqr_razorpay: PaymentApplicationModel.AggregatorRoute(),
+      ccavenue: PaymentApplicationModel.AggregatorRoute(),
+      epaylater: PaymentApplicationModel.AggregatorRoute(),
+      fynd: PaymentApplicationModel.AggregatorRoute(),
+      jiopay: PaymentApplicationModel.AggregatorRoute(),
+      juspay: PaymentApplicationModel.AggregatorRoute(),
+      mswipe: PaymentApplicationModel.AggregatorRoute(),
+      payubiz: PaymentApplicationModel.AggregatorRoute(),
+      razorpay: PaymentApplicationModel.AggregatorRoute(),
+      rupifi: PaymentApplicationModel.AggregatorRoute(),
+      simpl: PaymentApplicationModel.AggregatorRoute(),
+      stripe: PaymentApplicationModel.AggregatorRoute(),
+      upi_razorpay: PaymentApplicationModel.AggregatorRoute(),
     });
   }
+
+  /** @returns {PaymentInitializationRequest} */
   static PaymentInitializationRequest() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -572,6 +1594,8 @@ class PaymentModel {
       vpa: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {PaymentInitializationResponse} */
   static PaymentInitializationResponse() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -593,6 +1617,8 @@ class PaymentModel {
       vpa: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {PaymentMethodsMeta} */
   static PaymentMethodsMeta() {
     return Joi.object({
       merchant_code: Joi.string().allow("").required(),
@@ -600,6 +1626,8 @@ class PaymentModel {
       payment_identifier: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {PaymentModeList} */
   static PaymentModeList() {
     return Joi.object({
       aggregator_name: Joi.string().allow("").required(),
@@ -624,13 +1652,13 @@ class PaymentModel {
       exp_year: Joi.number().allow(null),
       expired: Joi.boolean().allow(null),
       fynd_vpa: Joi.string().allow("").allow(null),
-      intent_app: Joi.array().items(PaymentModel.IntentApp()),
+      intent_app: Joi.array().items(PaymentApplicationModel.IntentApp()),
       intent_app_error_dict_list: Joi.array().items(
-        PaymentModel.IntentAppErrorList()
+        PaymentApplicationModel.IntentAppErrorList()
       ),
       intent_app_error_list: Joi.array().items(Joi.string().allow("")),
       intent_flow: Joi.boolean().allow(null),
-      logo_url: PaymentModel.PaymentModeLogo(),
+      logo_url: PaymentApplicationModel.PaymentModeLogo(),
       merchant_code: Joi.string().allow("").allow(null),
       name: Joi.string().allow("").allow(null),
       nickname: Joi.string().allow("").allow(null),
@@ -639,26 +1667,34 @@ class PaymentModel {
       timeout: Joi.number().allow(null),
     });
   }
+
+  /** @returns {PaymentModeLogo} */
   static PaymentModeLogo() {
     return Joi.object({
       large: Joi.string().allow("").required(),
       small: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {PaymentModeRouteResponse} */
   static PaymentModeRouteResponse() {
     return Joi.object({
-      payment_options: PaymentModel.PaymentOptionAndFlow().required(),
+      payment_options: PaymentApplicationModel.PaymentOptionAndFlow().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {PaymentOptionAndFlow} */
   static PaymentOptionAndFlow() {
     return Joi.object({
-      payment_flows: PaymentModel.PaymentFlow().required(),
+      payment_flows: PaymentApplicationModel.PaymentFlow().required(),
       payment_option: Joi.array()
-        .items(PaymentModel.RootPaymentMode())
+        .items(PaymentApplicationModel.RootPaymentMode())
         .required(),
     });
   }
+
+  /** @returns {PaymentStatusUpdateRequest} */
   static PaymentStatusUpdateRequest() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -676,6 +1712,8 @@ class PaymentModel {
       vpa: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PaymentStatusUpdateResponse} */
   static PaymentStatusUpdateResponse() {
     return Joi.object({
       aggregator_name: Joi.string().allow("").required(),
@@ -685,6 +1723,8 @@ class PaymentModel {
       success: Joi.boolean().allow(null),
     });
   }
+
+  /** @returns {PollingPaymentLinkResponse} */
   static PollingPaymentLinkResponse() {
     return Joi.object({
       aggregator_name: Joi.string().allow("").allow(null),
@@ -699,18 +1739,24 @@ class PaymentModel {
       success: Joi.boolean().allow(null),
     });
   }
+
+  /** @returns {RedirectToAggregatorResponse} */
   static RedirectToAggregatorResponse() {
     return Joi.object({
-      data: PaymentModel.RedirectURL().required(),
+      data: PaymentApplicationModel.RedirectURL().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {RedirectURL} */
   static RedirectURL() {
     return Joi.object({
       signup_url: Joi.string().allow("").required(),
       status: Joi.boolean().required(),
     });
   }
+
+  /** @returns {RefundAccountResponse} */
   static RefundAccountResponse() {
     return Joi.object({
       data: Joi.any(),
@@ -719,17 +1765,23 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {renderHTMLRequest} */
   static renderHTMLRequest() {
     return Joi.object({
       base64_html: Joi.string().allow("").required(),
       returntype: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {renderHTMLResponse} */
   static renderHTMLResponse() {
     return Joi.object({
       html: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ResendOrCancelPaymentRequest} */
   static ResendOrCancelPaymentRequest() {
     return Joi.object({
       device_id: Joi.string().allow("").allow(null),
@@ -737,12 +1789,16 @@ class PaymentModel {
       request_type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ResendOrCancelPaymentResponse} */
   static ResendOrCancelPaymentResponse() {
     return Joi.object({
-      data: PaymentModel.LinkStatus().required(),
+      data: PaymentApplicationModel.LinkStatus().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {ResendPaymentLinkResponse} */
   static ResendPaymentLinkResponse() {
     return Joi.object({
       message: Joi.string().allow("").required(),
@@ -751,6 +1807,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {RootPaymentMode} */
   static RootPaymentMode() {
     return Joi.object({
       add_card_enabled: Joi.boolean().allow(null),
@@ -759,35 +1817,45 @@ class PaymentModel {
       display_name: Joi.string().allow("").required(),
       display_priority: Joi.number().required(),
       is_pay_by_card_pl: Joi.boolean().allow(null),
-      list: Joi.array().items(PaymentModel.PaymentModeList()),
+      list: Joi.array().items(PaymentApplicationModel.PaymentModeList()),
       name: Joi.string().allow("").required(),
       save_card: Joi.boolean().allow(null),
     });
   }
+
+  /** @returns {RupifiBannerData} */
   static RupifiBannerData() {
     return Joi.object({
       kyc_url: Joi.string().allow(""),
       status: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RupifiBannerResponse} */
   static RupifiBannerResponse() {
     return Joi.object({
-      data: PaymentModel.RupifiBannerData().required(),
+      data: PaymentApplicationModel.RupifiBannerData().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {SetDefaultBeneficiaryRequest} */
   static SetDefaultBeneficiaryRequest() {
     return Joi.object({
       beneficiary_id: Joi.string().allow("").required(),
       order_id: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {SetDefaultBeneficiaryResponse} */
   static SetDefaultBeneficiaryResponse() {
     return Joi.object({
       is_beneficiary_set: Joi.boolean().required(),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {TransferItemsDetails} */
   static TransferItemsDetails() {
     return Joi.object({
       display_name: Joi.string().allow(""),
@@ -797,31 +1865,43 @@ class PaymentModel {
       name: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {TransferModeDetails} */
   static TransferModeDetails() {
     return Joi.object({
       display_name: Joi.string().allow("").required(),
-      items: Joi.array().items(PaymentModel.TransferItemsDetails()),
+      items: Joi.array().items(PaymentApplicationModel.TransferItemsDetails()),
     });
   }
+
+  /** @returns {TransferModeResponse} */
   static TransferModeResponse() {
     return Joi.object({
-      data: Joi.array().items(PaymentModel.TransferModeDetails()).required(),
+      data: Joi.array()
+        .items(PaymentApplicationModel.TransferModeDetails())
+        .required(),
     });
   }
+
+  /** @returns {UpdateRefundTransferModeRequest} */
   static UpdateRefundTransferModeRequest() {
     return Joi.object({
       enable: Joi.boolean().required(),
       transfer_mode: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {UpdateRefundTransferModeResponse} */
   static UpdateRefundTransferModeResponse() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {UserPersonalInfoInDetails} */
   static UserPersonalInfoInDetails() {
     return Joi.object({
-      address_as_per_id: PaymentModel.KYCAddress().required(),
+      address_as_per_id: PaymentApplicationModel.KYCAddress().required(),
       dob: Joi.string().allow("").allow(null).required(),
       driving_license: Joi.string().allow("").allow(null),
       email: Joi.string().allow("").allow(null),
@@ -839,6 +1919,8 @@ class PaymentModel {
       voter_id: Joi.string().allow("").allow(null),
     });
   }
+
+  /** @returns {ValidateCustomerRequest} */
   static ValidateCustomerRequest() {
     return Joi.object({
       aggregator: Joi.string().allow("").required(),
@@ -851,6 +1933,8 @@ class PaymentModel {
       transaction_amount_in_paise: Joi.number().required(),
     });
   }
+
+  /** @returns {ValidateCustomerResponse} */
   static ValidateCustomerResponse() {
     return Joi.object({
       data: Joi.any().required(),
@@ -858,6 +1942,8 @@ class PaymentModel {
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {ValidateUPI} */
   static ValidateUPI() {
     return Joi.object({
       customer_name: Joi.string().allow("").required(),
@@ -866,23 +1952,31 @@ class PaymentModel {
       upi_vpa: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ValidateVPARequest} */
   static ValidateVPARequest() {
     return Joi.object({
       upi_vpa: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ValidateVPAResponse} */
   static ValidateVPAResponse() {
     return Joi.object({
-      data: PaymentModel.ValidateUPI().required(),
+      data: PaymentApplicationModel.ValidateUPI().required(),
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {WalletOtpRequest} */
   static WalletOtpRequest() {
     return Joi.object({
       country_code: Joi.string().allow("").required(),
       mobile: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {WalletOtpResponse} */
   static WalletOtpResponse() {
     return Joi.object({
       is_verified_flag: Joi.string().allow("").required(),
@@ -890,6 +1984,8 @@ class PaymentModel {
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {WrongOtpError} */
   static WrongOtpError() {
     return Joi.object({
       description: Joi.string().allow("").required(),
@@ -898,4 +1994,4 @@ class PaymentModel {
     });
   }
 }
-module.exports = PaymentModel;
+module.exports = PaymentApplicationModel;