@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

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

@@ -4,6 +4,28 @@ export = PaymentPlatformModel;
  * @property {BankDetailsForOTP} details
  * @property {string} order_id
  */
+/**
+ * @typedef AddressDetail
+ * @property {string} address - Address details
+ * @property {string} address_type - Address type e.g. home, office
+ * @property {string} area - Area details
+ * @property {string} area_code - Customer pin/zip code
+ * @property {string} area_code_slug - Area slug code, use pin/zip code if not available
+ * @property {string} city - City name
+ * @property {string} country - Country name
+ * @property {string} country_iso_code - Country's code name e.g. `IN`, `GB`
+ * @property {string} country_phone_code - Country's phone code
+ * @property {string} [email] - Customer email
+ * @property {string} [expire_at] - Address expiry timestamp
+ * @property {string} g_address_id - Unique address id generated by Fynd platform
+ * @property {Object} [geo_location] - Location latitude and logitude
+ * @property {Object} [google_map_point] - Google map point of location
+ * @property {string} [landmark] - Landmark
+ * @property {string} name - Customer name
+ * @property {string} phone - Phone number
+ * @property {string} state - State of the customer
+ * @property {Object[]} [tags] - Optional address tag
+ */
 /**
  * @typedef BankDetailsForOTP
  * @property {string} account_holder
@@ -167,7 +189,7 @@ export = PaymentPlatformModel;
  */
 /**
  * @typedef ErrorResponse
- * @property {ErrorDescription} [error]
+ * @property {Object} [error]
  * @property {string} message - Message
  * @property {number} status_code - HTTP status code
  * @property {boolean} success - Successful or failure
@@ -218,7 +240,7 @@ export = PaymentPlatformModel;
  * @typedef IntentApp
  * @property {string} [code] - Code
  * @property {string} [display_name] - Display_name
- * @property {PaymentModeLogo} [logos] - Logos
+ * @property {Object} [logos] - Logos
  * @property {string} [package_name] - Package_name
  */
 /**
@@ -244,6 +266,17 @@ export = PaymentPlatformModel;
  * @property {Object} data
  * @property {boolean} success - Success/Failure of the transaction
  */
+/**
+ * @typedef MerchnatPaymentModeRequest
+ * @property {Object} [offline] - Details to be updated for online payment configuration.
+ * @property {Object} [online] - Details to be updated for offline payment configuration.
+ */
+/**
+ * @typedef MerchnatPaymentModeResponse
+ * @property {Object[]} [items] - List of all aggregator and payment mode details.
+ * @property {string} [message] - Message
+ * @property {boolean} success - Response is successful or not.
+ */
 /**
  * @typedef MultiTenderPaymentMeta
  * @property {string} [current_status]
@@ -292,6 +325,18 @@ export = PaymentPlatformModel;
  * @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order
  * @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
  */
+/**
+ * @typedef OrderDetail
+ * @property {string} aggregator - Name of the payment gateway aggregator.
+ * @property {Object} aggregator_order_details - Aggregator order details
+ *   generated by the payment gateway.
+ * @property {number} amount - Amount paid.
+ * @property {string} currency - Currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {string} status - Order status created by payment gateway aggregator.
+ */
 /**
  * @typedef Page
  * @property {number} [current]
@@ -415,7 +460,7 @@ export = PaymentPlatformModel;
  *   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 {Object} [logo_url] - Logo
  * @property {string} [merchant_code] - Merchant code
  * @property {string} [name] - Name
  * @property {string} [nickname] - Nickname
@@ -458,6 +503,63 @@ export = PaymentPlatformModel;
  * @property {PaymentOptions} payment_options - Payment options
  * @property {boolean} success - Response is successful or not
  */
+/**
+ * @typedef PaymentSessionDetail
+ * @property {string} [aggregator_customer_id] - Unique customer id generated by
+ *   payment gateway, not required for standard checkout.
+ * @property {string} aggregator_order_id - Unique order id or payment request
+ *   id generated by payment gateway
+ * @property {number} amount - Amount paid.
+ * @property {number} amount_captured - Amount which is captured or credited to
+ *   merchant account
+ * @property {number} [amount_refunded]
+ * @property {AddressDetail} billing_address - Billing address
+ * @property {string} cancel_url - Cancel url sent by Fynd platform at the time
+ *   of payment creation
+ * @property {boolean} [captured] - Whether the payment is captured (credited to
+ *   merchant account) by payment gateway.
+ * @property {string} [created] - Timestamp in epoch
+ * @property {string} currency - Currency of the payment.
+ * @property {string} g_user_id - Global user identifier - unique user id
+ *   generated by Fynd platform
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {string} [kind] - Optional kind of purchase/payment - one time
+ *   payment (sale) or subcription. defaults to sale.
+ * @property {string} [locale] - User's locale
+ * @property {string} [merchant_locale] - Merchant's locale
+ * @property {string} mode - Test or live, test mode uses test credentials so
+ *   that actual payment is not created.
+ * @property {string} payment_id - Unique transaction id generated by payment gateway
+ * @property {Object[]} payment_methods - Method of payment
+ * @property {AddressDetail} shipping_address - Shipping address
+ * @property {string} status - Stautus of the payment
+ * @property {string} success_url - Success url sent by Fynd platform at the
+ *   time of payment creation
+ */
+/**
+ * @typedef PaymentSessionRequestSerializer
+ * @property {string} currency - Currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {OrderDetail} order_details - The details of the order.
+ * @property {PaymentSessionDetail[]} payment_details - The payment details with
+ *   the schema `PaymentSessionDetail`.
+ * @property {string} status - Status of the payment.
+ * @property {number} total_amount - Amount paid.
+ */
+/**
+ * @typedef PaymentSessionResponseSerializer
+ * @property {string} currency - Currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {Object[]} platform_transaction_details - Platform transaction details.
+ * @property {string} status - Status of the payment.
+ * @property {number} total_amount - Amount paid.
+ */
 /**
  * @typedef PaymentStatusBulkHandlerRequest
  * @property {string[]} merchant_order_id - List of order ids
@@ -595,6 +697,44 @@ export = PaymentPlatformModel;
  * @property {string} message - Response message
  * @property {boolean} success - Success or failure flag.
  */
+/**
+ * @typedef RefundSessionDetail
+ * @property {number} amount - Amount refunded.
+ * @property {string} [balance_transaction] - Balance transaction.
+ * @property {string} created - Timestamp in epoch.
+ * @property {string} currency - Currency of the payment.
+ * @property {string} payment_id - Unique payment id generated by payment gateway.
+ * @property {string} [reason] - Reason for refund, optional
+ * @property {string} [receipt_number] - Unique receipt for refund, generated by
+ *   payment gateway, if not available can be utr.
+ * @property {string} [refund_utr] - Unique refund utr generated by payment gateway.
+ * @property {string} request_id - Refund request id, unique id generated by Fynd platform
+ * @property {string} [source_transfer_reversal] - Description in case of
+ *   reversal of payment.
+ * @property {string} status - Status of the refund.
+ * @property {string} [transfer_reversal] - Description in case of reversal of payment.
+ */
+/**
+ * @typedef RefundSessionRequestSerializer
+ * @property {string} currency - The currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {PaymentSessionDetail} payment_details - Details of the payment
+ * @property {RefundSessionDetail[]} [refund_details] - Details of the refund
+ * @property {string} status - The status of the refund.
+ * @property {number} total_amount - The total amount refunded.
+ */
+/**
+ * @typedef RefundSessionResponseSerializer
+ * @property {string} currency - The currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {Object[]} platform_refund_details - Details of the refund
+ * @property {string} status - The status of the refund.
+ * @property {number} total_refund_amount - The total amount refunded.
+ */
 /**
  * @typedef RepaymentDetailsSerialiserPayAll
  * @property {string} aggregator_order_id - Id of payment gateway
@@ -725,7 +865,7 @@ export = PaymentPlatformModel;
 declare class PaymentPlatformModel {
 }
 declare namespace PaymentPlatformModel {
-    export { AddBeneficiaryDetailsOTPRequest, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, NotFoundResourceError, OrderBeneficiaryDetails, OrderBeneficiaryResponse, Page, PaymentCode, PaymentConfirmationRequest, PaymentConfirmationResponse, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayConfigResponse, PaymentGatewayToBeReviewed, PaymentInitializationRequest, PaymentInitializationResponse, PaymentModeList, PaymentModeLogo, PaymentObjectListSerializer, PaymentOptions, PaymentOptionsResponse, PaymentStatusBulkHandlerRequest, PaymentStatusBulkHandlerResponse, PaymentStatusObject, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, Payout, PayoutAggregator, PayoutBankDetails, PayoutCustomer, PayoutMoreAttributes, PayoutRequest, PayoutResponse, PayoutsResponse, PollingPaymentLinkResponse, RefundAccountResponse, RepaymentDetailsSerialiserPayAll, RepaymentRequestDetails, RepaymentResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RevokeOAuthToken, RootPaymentMode, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, SetCODForUserRequest, SetCODOptionResponse, StatisticsData, SubscriptionConfigResponse, SubscriptionPaymentMethodResponse, UpdatePayoutRequest, UpdatePayoutResponse, ValidateCustomerRequest, ValidateCustomerResponse };
+    export { AddBeneficiaryDetailsOTPRequest, AddressDetail, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse, MerchnatPaymentModeRequest, MerchnatPaymentModeResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, NotFoundResourceError, OrderBeneficiaryDetails, OrderBeneficiaryResponse, OrderDetail, Page, PaymentCode, PaymentConfirmationRequest, PaymentConfirmationResponse, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayConfigResponse, PaymentGatewayToBeReviewed, PaymentInitializationRequest, PaymentInitializationResponse, PaymentModeList, PaymentModeLogo, PaymentObjectListSerializer, PaymentOptions, PaymentOptionsResponse, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, PaymentStatusBulkHandlerRequest, PaymentStatusBulkHandlerResponse, PaymentStatusObject, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, Payout, PayoutAggregator, PayoutBankDetails, PayoutCustomer, PayoutMoreAttributes, PayoutRequest, PayoutResponse, PayoutsResponse, PollingPaymentLinkResponse, RefundAccountResponse, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, RepaymentDetailsSerialiserPayAll, RepaymentRequestDetails, RepaymentResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RevokeOAuthToken, RootPaymentMode, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, SetCODForUserRequest, SetCODOptionResponse, StatisticsData, SubscriptionConfigResponse, SubscriptionPaymentMethodResponse, UpdatePayoutRequest, UpdatePayoutResponse, ValidateCustomerRequest, ValidateCustomerResponse };
 }
 /** @returns {AddBeneficiaryDetailsOTPRequest} */
 declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
@@ -733,6 +873,86 @@ type AddBeneficiaryDetailsOTPRequest = {
     details: BankDetailsForOTP;
     order_id: string;
 };
+/** @returns {AddressDetail} */
+declare function AddressDetail(): AddressDetail;
+type AddressDetail = {
+    /**
+     * - Address details
+     */
+    address: string;
+    /**
+     * - Address type e.g. home, office
+     */
+    address_type: string;
+    /**
+     * - Area details
+     */
+    area: string;
+    /**
+     * - Customer pin/zip code
+     */
+    area_code: string;
+    /**
+     * - Area slug code, use pin/zip code if not available
+     */
+    area_code_slug: string;
+    /**
+     * - City name
+     */
+    city: string;
+    /**
+     * - Country name
+     */
+    country: string;
+    /**
+     * - Country's code name e.g. `IN`, `GB`
+     */
+    country_iso_code: string;
+    /**
+     * - Country's phone code
+     */
+    country_phone_code: string;
+    /**
+     * - Customer email
+     */
+    email?: string;
+    /**
+     * - Address expiry timestamp
+     */
+    expire_at?: string;
+    /**
+     * - Unique address id generated by Fynd platform
+     */
+    g_address_id: string;
+    /**
+     * - Location latitude and logitude
+     */
+    geo_location?: any;
+    /**
+     * - Google map point of location
+     */
+    google_map_point?: any;
+    /**
+     * - Landmark
+     */
+    landmark?: string;
+    /**
+     * - Customer name
+     */
+    name: string;
+    /**
+     * - Phone number
+     */
+    phone: string;
+    /**
+     * - State of the customer
+     */
+    state: string;
+    /**
+     * - Optional address tag
+     */
+    tags?: any[];
+};
 /** @returns {BankDetailsForOTP} */
 declare function BankDetailsForOTP(): BankDetailsForOTP;
 type BankDetailsForOTP = {
@@ -1154,7 +1374,7 @@ type ErrorDescription = {
 /** @returns {ErrorResponse} */
 declare function ErrorResponse(): ErrorResponse;
 type ErrorResponse = {
-    error?: ErrorDescription;
+    error?: any;
     /**
      * - Message
      */
@@ -1291,7 +1511,7 @@ type IntentApp = {
     /**
      * - Logos
      */
-    logos?: PaymentModeLogo;
+    logos?: any;
     /**
      * - Package_name
      */
@@ -1354,6 +1574,34 @@ type MerchantOnBoardingResponse = {
      */
     success: boolean;
 };
+/** @returns {MerchnatPaymentModeRequest} */
+declare function MerchnatPaymentModeRequest(): MerchnatPaymentModeRequest;
+type MerchnatPaymentModeRequest = {
+    /**
+     * - Details to be updated for online payment configuration.
+     */
+    offline?: any;
+    /**
+     * - Details to be updated for offline payment configuration.
+     */
+    online?: any;
+};
+/** @returns {MerchnatPaymentModeResponse} */
+declare function MerchnatPaymentModeResponse(): MerchnatPaymentModeResponse;
+type MerchnatPaymentModeResponse = {
+    /**
+     * - List of all aggregator and payment mode details.
+     */
+    items?: any[];
+    /**
+     * - Message
+     */
+    message?: string;
+    /**
+     * - Response is successful or not.
+     */
+    success: boolean;
+};
 /** @returns {MultiTenderPaymentMeta} */
 declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
 type MultiTenderPaymentMeta = {
@@ -1485,6 +1733,37 @@ type OrderBeneficiaryResponse = {
      */
     show_beneficiary_details?: boolean;
 };
+/** @returns {OrderDetail} */
+declare function OrderDetail(): OrderDetail;
+type OrderDetail = {
+    /**
+     * - Name of the payment gateway aggregator.
+     */
+    aggregator: string;
+    /**
+     * - Aggregator order details
+     * generated by the payment gateway.
+     */
+    aggregator_order_details: any;
+    /**
+     * - Amount paid.
+     */
+    amount: number;
+    /**
+     * - Currency of the payment.
+     */
+    currency: string;
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    /**
+     * - Order status created by payment gateway aggregator.
+     */
+    status: string;
+};
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
@@ -1859,7 +2138,7 @@ type PaymentModeList = {
     /**
      * - Logo
      */
-    logo_url?: PaymentModeLogo;
+    logo_url?: any;
     /**
      * - Merchant code
      */
@@ -1939,6 +2218,159 @@ type PaymentOptionsResponse = {
      */
     success: boolean;
 };
+/** @returns {PaymentSessionDetail} */
+declare function PaymentSessionDetail(): PaymentSessionDetail;
+type PaymentSessionDetail = {
+    /**
+     * - Unique customer id generated by
+     * payment gateway, not required for standard checkout.
+     */
+    aggregator_customer_id?: string;
+    /**
+     * - Unique order id or payment request
+     * id generated by payment gateway
+     */
+    aggregator_order_id: string;
+    /**
+     * - Amount paid.
+     */
+    amount: number;
+    /**
+     * - Amount which is captured or credited to
+     * merchant account
+     */
+    amount_captured: number;
+    amount_refunded?: number;
+    /**
+     * - Billing address
+     */
+    billing_address: AddressDetail;
+    /**
+     * - Cancel url sent by Fynd platform at the time
+     * of payment creation
+     */
+    cancel_url: string;
+    /**
+     * - Whether the payment is captured (credited to
+     * merchant account) by payment gateway.
+     */
+    captured?: boolean;
+    /**
+     * - Timestamp in epoch
+     */
+    created?: string;
+    /**
+     * - Currency of the payment.
+     */
+    currency: string;
+    /**
+     * - Global user identifier - unique user id
+     * generated by Fynd platform
+     */
+    g_user_id: string;
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    /**
+     * - Optional kind of purchase/payment - one time
+     * payment (sale) or subcription. defaults to sale.
+     */
+    kind?: string;
+    /**
+     * - User's locale
+     */
+    locale?: string;
+    /**
+     * - Merchant's locale
+     */
+    merchant_locale?: string;
+    /**
+     * - Test or live, test mode uses test credentials so
+     * that actual payment is not created.
+     */
+    mode: string;
+    /**
+     * - Unique transaction id generated by payment gateway
+     */
+    payment_id: string;
+    /**
+     * - Method of payment
+     */
+    payment_methods: any[];
+    /**
+     * - Shipping address
+     */
+    shipping_address: AddressDetail;
+    /**
+     * - Stautus of the payment
+     */
+    status: string;
+    /**
+     * - Success url sent by Fynd platform at the
+     * time of payment creation
+     */
+    success_url: string;
+};
+/** @returns {PaymentSessionRequestSerializer} */
+declare function PaymentSessionRequestSerializer(): PaymentSessionRequestSerializer;
+type PaymentSessionRequestSerializer = {
+    /**
+     * - Currency of the payment.
+     */
+    currency: string;
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    /**
+     * - The details of the order.
+     */
+    order_details: OrderDetail;
+    /**
+     * - The payment details with
+     * the schema `PaymentSessionDetail`.
+     */
+    payment_details: PaymentSessionDetail[];
+    /**
+     * - Status of the payment.
+     */
+    status: string;
+    /**
+     * - Amount paid.
+     */
+    total_amount: number;
+};
+/** @returns {PaymentSessionResponseSerializer} */
+declare function PaymentSessionResponseSerializer(): PaymentSessionResponseSerializer;
+type PaymentSessionResponseSerializer = {
+    /**
+     * - Currency of the payment.
+     */
+    currency: string;
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    /**
+     * - Platform transaction details.
+     */
+    platform_transaction_details: any[];
+    /**
+     * - Status of the payment.
+     */
+    status: string;
+    /**
+     * - Amount paid.
+     */
+    total_amount: number;
+};
 /** @returns {PaymentStatusBulkHandlerRequest} */
 declare function PaymentStatusBulkHandlerRequest(): PaymentStatusBulkHandlerRequest;
 type PaymentStatusBulkHandlerRequest = {
@@ -2310,6 +2742,116 @@ type RefundAccountResponse = {
      */
     success: boolean;
 };
+/** @returns {RefundSessionDetail} */
+declare function RefundSessionDetail(): RefundSessionDetail;
+type RefundSessionDetail = {
+    /**
+     * - Amount refunded.
+     */
+    amount: number;
+    /**
+     * - Balance transaction.
+     */
+    balance_transaction?: string;
+    /**
+     * - Timestamp in epoch.
+     */
+    created: string;
+    /**
+     * - Currency of the payment.
+     */
+    currency: string;
+    /**
+     * - Unique payment id generated by payment gateway.
+     */
+    payment_id: string;
+    /**
+     * - Reason for refund, optional
+     */
+    reason?: string;
+    /**
+     * - Unique receipt for refund, generated by
+     * payment gateway, if not available can be utr.
+     */
+    receipt_number?: string;
+    /**
+     * - Unique refund utr generated by payment gateway.
+     */
+    refund_utr?: string;
+    /**
+     * - Refund request id, unique id generated by Fynd platform
+     */
+    request_id: string;
+    /**
+     * - Description in case of
+     * reversal of payment.
+     */
+    source_transfer_reversal?: string;
+    /**
+     * - Status of the refund.
+     */
+    status: string;
+    /**
+     * - Description in case of reversal of payment.
+     */
+    transfer_reversal?: string;
+};
+/** @returns {RefundSessionRequestSerializer} */
+declare function RefundSessionRequestSerializer(): RefundSessionRequestSerializer;
+type RefundSessionRequestSerializer = {
+    /**
+     * - The currency of the payment.
+     */
+    currency: string;
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    /**
+     * - Details of the payment
+     */
+    payment_details: PaymentSessionDetail;
+    /**
+     * - Details of the refund
+     */
+    refund_details?: RefundSessionDetail[];
+    /**
+     * - The status of the refund.
+     */
+    status: string;
+    /**
+     * - The total amount refunded.
+     */
+    total_amount: number;
+};
+/** @returns {RefundSessionResponseSerializer} */
+declare function RefundSessionResponseSerializer(): RefundSessionResponseSerializer;
+type RefundSessionResponseSerializer = {
+    /**
+     * - The currency of the payment.
+     */
+    currency: string;
+    /**
+     * - Global identifier of the entity (e.g. order, cart
+     * etc.) against which payment_session was initiated. This is generated by
+     * Fynd payments platform and is unique.
+     */
+    gid: string;
+    /**
+     * - Details of the refund
+     */
+    platform_refund_details: any[];
+    /**
+     * - The status of the refund.
+     */
+    status: string;
+    /**
+     * - The total amount refunded.
+     */
+    total_refund_amount: number;
+};
 /** @returns {RepaymentDetailsSerialiserPayAll} */
 declare function RepaymentDetailsSerialiserPayAll(): RepaymentDetailsSerialiserPayAll;
 type RepaymentDetailsSerialiserPayAll = {