cashfree-pg 4.2.0 → 4.2.2

package/dist/api.d.ts

@@ -528,6 +528,61 @@ export interface BanktransferPaymentMethod {
      */
     'banktransfer': Banktransfer;
 }
+/**
+ * payment method card.
+ * @export
+ * @interface CARD
+ */
+export interface CARD {
+    /**
+     * Channel. can be link
+     * @type {string}
+     * @memberof CARD
+     */
+    'channel'?: string;
+    /**
+     * Card number
+     * @type {string}
+     * @memberof CARD
+     */
+    'card_number'?: string;
+    /**
+     * Card holder name
+     * @type {string}
+     * @memberof CARD
+     */
+    'card_holder_name'?: string;
+    /**
+     * Card expiry month
+     * @type {string}
+     * @memberof CARD
+     */
+    'card_expiry_mm'?: string;
+    /**
+     * Card expiry year
+     * @type {string}
+     * @memberof CARD
+     */
+    'card_expiry_yy'?: string;
+    /**
+     * Card CVV
+     * @type {string}
+     * @memberof CARD
+     */
+    'card_cvv'?: string;
+    /**
+     * Card network
+     * @type {string}
+     * @memberof CARD
+     */
+    'card_network'?: string;
+    /**
+     * Card type
+     * @type {string}
+     * @memberof CARD
+     */
+    'card_type'?: string;
+}
 /**
  * Card Payment method
  * @export
@@ -1264,206 +1319,132 @@ export interface CreatePlanRequest {
     'plan_note'?: string;
 }
 /**
- * The response returned in Get, Create or Manage Subscription Payment APIs.
+ * The request to be passed for the create subscription payment API.
  * @export
- * @interface CreateSubscriptionPaymentAuthResponse
+ * @interface CreateSubscriptionPaymentRequest
  */
-export interface CreateSubscriptionPaymentAuthResponse {
+export interface CreateSubscriptionPaymentRequest {
     /**
-     * Cashfree subscription payment reference number
+     * A unique ID passed by merchant for identifying the subscription.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     * @memberof CreateSubscriptionPaymentRequest
      */
-    'cf_payment_id'?: string;
+    'subscription_id': string;
     /**
-     * Cashfree subscription reference number
+     * Session ID for the subscription. Required only for Auth.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     * @memberof CreateSubscriptionPaymentRequest
      */
-    'cf_subscription_id'?: string;
+    'subscription_session_id'?: string;
     /**
-     *
-     * @type {CreateSubscriptionPaymentAuthResponseFailureDetails}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     * A unique ID passed by merchant for identifying the subscription payment.
+     * @type {string}
+     * @memberof CreateSubscriptionPaymentRequest
      */
-    'failure_details'?: CreateSubscriptionPaymentAuthResponseFailureDetails;
+    'payment_id': string;
     /**
-     * The charge amount of the payment.
+     * The charge amount of the payment. Required in case of charge.
      * @type {number}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     * @memberof CreateSubscriptionPaymentRequest
      */
     'payment_amount'?: number;
     /**
-     * A unique ID passed by merchant for identifying the transaction.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
-     */
-    'payment_id'?: string;
-    /**
-     * The date on which the payment was initiated.
+     * The date on which the payment is scheduled to be processed. Required for UPI and CARD payment modes.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     * @memberof CreateSubscriptionPaymentRequest
      */
-    'payment_initiated_date'?: string;
+    'payment_schedule_date'?: string;
     /**
-     * Status of the payment.
+     * Payment remarks.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     * @memberof CreateSubscriptionPaymentRequest
      */
-    'payment_status'?: string;
+    'payment_remarks'?: string;
     /**
      * Payment type. Can be AUTH or CHARGE.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
-     */
-    'payment_type'?: string;
-    /**
-     * A unique ID passed by merchant for identifying the subscription.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     * @memberof CreateSubscriptionPaymentRequest
      */
-    'subscription_id'?: string;
+    'payment_type': string;
     /**
-     * Payment method used for the authorization.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponse
+     *
+     * @type {CreateSubscriptionPaymentRequestPaymentMethod}
+     * @memberof CreateSubscriptionPaymentRequest
      */
-    'payment_method'?: string;
+    'payment_method'?: CreateSubscriptionPaymentRequestPaymentMethod;
 }
 /**
- *
+ * @type CreateSubscriptionPaymentRequestPaymentMethod
+ * Payment method. Can be one of [\"upi\", \"enach\", \"pnach\", \"card\"]
  * @export
- * @interface CreateSubscriptionPaymentAuthResponseFailureDetails
  */
-export interface CreateSubscriptionPaymentAuthResponseFailureDetails {
-    /**
-     * Failure reason of the payment if the payment_status is failed.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentAuthResponseFailureDetails
-     */
-    'failure_reason'?: string;
-}
+export type CreateSubscriptionPaymentRequestPaymentMethod = CARD | ENACH | PNACH | UPI;
 /**
- * The response returned in Get, Create or Manage Subscription Payment APIs.
+ * The response returned is Create Subscription Auth or Charge APIs.
  * @export
- * @interface CreateSubscriptionPaymentChargeResponse
+ * @interface CreateSubscriptionPaymentResponse
  */
-export interface CreateSubscriptionPaymentChargeResponse {
+export interface CreateSubscriptionPaymentResponse {
     /**
      * Cashfree subscription payment reference number
      * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @memberof CreateSubscriptionPaymentResponse
      */
     'cf_payment_id'?: string;
-    /**
-     * Cashfree subscription reference number
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
-     */
-    'cf_subscription_id'?: string;
     /**
      *
-     * @type {CreateSubscriptionPaymentAuthResponseFailureDetails}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @type {SubscriptionPaymentEntityFailureDetails}
+     * @memberof CreateSubscriptionPaymentResponse
      */
-    'failure_details'?: CreateSubscriptionPaymentAuthResponseFailureDetails;
+    'failure_details'?: SubscriptionPaymentEntityFailureDetails;
     /**
      * The charge amount of the payment.
      * @type {number}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @memberof CreateSubscriptionPaymentResponse
      */
     'payment_amount'?: number;
     /**
      * A unique ID passed by merchant for identifying the transaction.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @memberof CreateSubscriptionPaymentResponse
      */
     'payment_id'?: string;
     /**
      * The date on which the payment was initiated.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @memberof CreateSubscriptionPaymentResponse
      */
     'payment_initiated_date'?: string;
     /**
      * Status of the payment.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @memberof CreateSubscriptionPaymentResponse
      */
     'payment_status'?: string;
     /**
      * Payment type. Can be AUTH or CHARGE.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @memberof CreateSubscriptionPaymentResponse
      */
     'payment_type'?: string;
     /**
      * A unique ID passed by merchant for identifying the subscription.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
+     * @memberof CreateSubscriptionPaymentResponse
      */
     'subscription_id'?: string;
     /**
-     * Payment method used for the authorization.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentChargeResponse
-     */
-    'payment_method'?: string;
-}
-/**
- * The request to be passed for the create subscription payment API.
- * @export
- * @interface CreateSubscriptionPaymentRequest
- */
-export interface CreateSubscriptionPaymentRequest {
-    /**
-     * A unique ID passed by merchant for identifying the subscription.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentRequest
-     */
-    'subscription_id': string;
-    /**
-     * Session ID for the subscription. Required only for Auth.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentRequest
-     */
-    'subscription_session_id'?: string;
-    /**
-     * A unique ID passed by merchant for identifying the subscription payment.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentRequest
-     */
-    'payment_id': string;
-    /**
-     * The charge amount of the payment. Required in case of charge.
-     * @type {number}
-     * @memberof CreateSubscriptionPaymentRequest
-     */
-    'payment_amount'?: number;
-    /**
-     * The date on which the payment is scheduled to be processed. Required for UPI and CARD payment modes.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentRequest
-     */
-    'payment_schedule_date'?: string;
-    /**
-     * Payment remarks.
-     * @type {string}
-     * @memberof CreateSubscriptionPaymentRequest
+     * Contains a payload for auth app links in case of AUTH. For charge, the payload is empty.
+     * @type {object}
+     * @memberof CreateSubscriptionPaymentResponse
      */
-    'payment_remarks'?: string;
+    'data'?: object;
     /**
-     * Payment type. Can be AUTH or CHARGE.
+     * Payment method used for the authorization.
      * @type {string}
-     * @memberof CreateSubscriptionPaymentRequest
+     * @memberof CreateSubscriptionPaymentResponse
      */
-    'payment_type': string;
-    /**
-     * Payment method. Can be one of [\"upi\", \"enach\", \"pnach\", \"card\"]
-     * @type {object}
-     * @memberof CreateSubscriptionPaymentRequest
-     */
-    'payment_method'?: object;
+    'payment_method'?: string;
 }
 /**
  * Request body to create a subscription refund.
@@ -1840,7 +1821,7 @@ export interface CreateVendorRequest {
      */
     'dashboard_access'?: boolean;
     /**
-     * Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table.  If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements.
+     * Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table. If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements.
      * @type {number}
      * @memberof CreateVendorRequest
      */
@@ -1987,7 +1968,7 @@ export interface CryptogramEntity {
     'card_display'?: string;
 }
 /**
- * The customer details that are necessary.
+ * The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.
  * @export
  * @interface CustomerDetails
  */
@@ -2239,6 +2220,55 @@ export interface EMIPlansArray {
      */
     'total_amount'?: number;
 }
+/**
+ * payment method enach.
+ * @export
+ * @interface ENACH
+ */
+export interface ENACH {
+    /**
+     * Channel. can be link
+     * @type {string}
+     * @memberof ENACH
+     */
+    'channel'?: string;
+    /**
+     * Authentication mode. can be debit_card, aadhaar, or net_banking
+     * @type {string}
+     * @memberof ENACH
+     */
+    'auth_mode'?: string;
+    /**
+     * Account holder name
+     * @type {string}
+     * @memberof ENACH
+     */
+    'account_holder_name'?: string;
+    /**
+     * Account number
+     * @type {string}
+     * @memberof ENACH
+     */
+    'account_number'?: string;
+    /**
+     * Account bank code (required without AccountIFSC)
+     * @type {string}
+     * @memberof ENACH
+     */
+    'account_bank_code'?: string;
+    /**
+     * Account type
+     * @type {string}
+     * @memberof ENACH
+     */
+    'account_type'?: string;
+    /**
+     * Account IFSC
+     * @type {string}
+     * @memberof ENACH
+     */
+    'account_ifsc'?: string;
+}
 /**
  * ES Order Recon Request
  * @export
@@ -4250,6 +4280,61 @@ export interface OrderPayData {
      */
     'method'?: string;
 }
+/**
+ * payment method pnach.
+ * @export
+ * @interface PNACH
+ */
+export interface PNACH {
+    /**
+     * Channel. can be post
+     * @type {string}
+     * @memberof PNACH
+     */
+    'channel'?: string;
+    /**
+     * Account holder name
+     * @type {string}
+     * @memberof PNACH
+     */
+    'account_holder_name'?: string;
+    /**
+     * Account number
+     * @type {string}
+     * @memberof PNACH
+     */
+    'account_number'?: string;
+    /**
+     * Account bank code
+     * @type {string}
+     * @memberof PNACH
+     */
+    'account_bank_code'?: string;
+    /**
+     * Account type
+     * @type {string}
+     * @memberof PNACH
+     */
+    'account_type'?: string;
+    /**
+     * Account IFSC
+     * @type {string}
+     * @memberof PNACH
+     */
+    'account_ifsc'?: string;
+    /**
+     * Mandate creation date
+     * @type {string}
+     * @memberof PNACH
+     */
+    'mandate_creation_date'?: string;
+    /**
+     * Mandate start date
+     * @type {string}
+     * @memberof PNACH
+     */
+    'mandate_start_date'?: string;
+}
 /**
  * Order Pay response once you create a transaction for that order
  * @export
@@ -6665,11 +6750,6 @@ export interface StaticSplitResponseSchemeInner {
      */
     'percentage'?: string;
 }
-/**
- * @type SubsCreatePayment200Response
- * @export
- */
-export type SubsCreatePayment200Response = CreateSubscriptionPaymentAuthResponse | CreateSubscriptionPaymentChargeResponse;
 /**
  * Bank details object
  * @export
@@ -6938,10 +7018,10 @@ export interface SubscriptionPaymentEntity {
     'cf_order_id'?: string;
     /**
      *
-     * @type {CreateSubscriptionPaymentAuthResponseFailureDetails}
+     * @type {SubscriptionPaymentEntityFailureDetails}
      * @memberof SubscriptionPaymentEntity
      */
-    'failure_details'?: CreateSubscriptionPaymentAuthResponseFailureDetails;
+    'failure_details'?: SubscriptionPaymentEntityFailureDetails;
     /**
      * The charge amount of the payment.
      * @type {number}
@@ -6997,6 +7077,19 @@ export interface SubscriptionPaymentEntity {
      */
     'subscription_id'?: string;
 }
+/**
+ *
+ * @export
+ * @interface SubscriptionPaymentEntityFailureDetails
+ */
+export interface SubscriptionPaymentEntityFailureDetails {
+    /**
+     * Failure reason of the payment if the payment_status is failed.
+     * @type {string}
+     * @memberof SubscriptionPaymentEntityFailureDetails
+     */
+    'failure_reason'?: string;
+}
 /**
  * Get/Create Subscription Payment Refund Response
  * @export
@@ -7461,6 +7554,25 @@ export interface TransferDetailsTagsInner {
      */
     'size'?: number;
 }
+/**
+ * payment method upi.
+ * @export
+ * @interface UPI
+ */
+export interface UPI {
+    /**
+     *
+     * @type {string}
+     * @memberof UPI
+     */
+    'upi_id'?: string;
+    /**
+     * Channel. can be link, qrcode, or collect
+     * @type {string}
+     * @memberof UPI
+     */
+    'channel'?: string;
+}
 /**
  * object when you are using preauth in UPI in order pay
  * @export
@@ -7678,7 +7790,7 @@ export interface UpdateVendorRequest {
      */
     'dashboard_access'?: boolean;
     /**
-     * Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table.  If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements.
+     * Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table. If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements.
      * @type {number}
      * @memberof UpdateVendorRequest
      */
@@ -7806,47 +7918,10 @@ export interface UpdateVendorResponse {
     'bank_details'?: string;
     /**
      *
-     * @type {Array<UpdateVendorResponseRelatedDocsInner>}
+     * @type {Array<VendorEntityRelatedDocsInner>}
      * @memberof UpdateVendorResponse
      */
-    'related_docs'?: Array<UpdateVendorResponseRelatedDocsInner>;
-}
-/**
- *
- * @export
- * @interface UpdateVendorResponseRelatedDocsInner
- */
-export interface UpdateVendorResponseRelatedDocsInner {
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateVendorResponseRelatedDocsInner
-     */
-    'vendor_id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateVendorResponseRelatedDocsInner
-     */
-    'doc_type'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateVendorResponseRelatedDocsInner
-     */
-    'doc_value'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateVendorResponseRelatedDocsInner
-     */
-    'status'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof UpdateVendorResponseRelatedDocsInner
-     */
-    'remarks'?: string;
+    'related_docs'?: Array<VendorEntityRelatedDocsInner>;
 }
 /**
  * UPI collect payment method object
@@ -8130,10 +8205,10 @@ export interface VendorDocumentDownloadResponse {
 export interface VendorDocumentsResponse {
     /**
      *
-     * @type {Array<UpdateVendorResponseRelatedDocsInner>}
+     * @type {Array<VendorEntityRelatedDocsInner>}
      * @memberof VendorDocumentsResponse
      */
-    'documents'?: Array<UpdateVendorResponseRelatedDocsInner>;
+    'documents'?: Array<VendorEntityRelatedDocsInner>;
 }
 /**
  * Vendor entity object
@@ -8227,10 +8302,47 @@ export interface VendorEntity {
     'remarks'?: string;
     /**
      *
-     * @type {Array<UpdateVendorResponseRelatedDocsInner>}
+     * @type {Array<VendorEntityRelatedDocsInner>}
      * @memberof VendorEntity
      */
-    'related_docs'?: Array<UpdateVendorResponseRelatedDocsInner>;
+    'related_docs'?: Array<VendorEntityRelatedDocsInner>;
+}
+/**
+ *
+ * @export
+ * @interface VendorEntityRelatedDocsInner
+ */
+export interface VendorEntityRelatedDocsInner {
+    /**
+     *
+     * @type {string}
+     * @memberof VendorEntityRelatedDocsInner
+     */
+    'vendor_id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VendorEntityRelatedDocsInner
+     */
+    'doc_type'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VendorEntityRelatedDocsInner
+     */
+    'doc_value'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VendorEntityRelatedDocsInner
+     */
+    'status'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VendorEntityRelatedDocsInner
+     */
+    'remarks'?: string;
 }
 /**
  * Use to split order when cashfree\'s Easy Split is enabled for your account.
@@ -8653,11 +8765,12 @@ export declare class Cashfree {
      * @param {string} link_id The payment link ID for which you want to view the details.
      * @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
      * @param {string} [x_idempotency_key] An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
+     * @param {string} [status] Mention What is status of orders you want to fetch, default is PAID. Possible value: ALL, PAID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PaymentLinksApi
      */
-    static PGLinkFetchOrders(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkOrderEntity[], any>>;
+    static PGLinkFetchOrders(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, status?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkOrderEntity[], any>>;
     /**
      * Use this API to capture or void a preauthorized payment
      * @summary Preauthorization
@@ -8947,7 +9060,7 @@ export declare class Cashfree {
      * @throws {RequiredError}
      * @memberof SubscriptionApi
      */
-    static SubsCreatePayment(x_api_version: string, CreateSubscriptionPaymentRequest: CreateSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubsCreatePayment200Response, any>>;
+    static SubsCreatePayment(x_api_version: string, CreateSubscriptionPaymentRequest: CreateSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSubscriptionPaymentResponse, any>>;
     /**
      * A plan allows your customer to identify the features you offer along with your pricing. You can create plans as per the pricing you support for your services. For each plan, you can set a pre-decided frequency and amount with which they’ll be charged. Example: Netflix Plans - Premium, Basic, Standard, Mobile. Each plan differs and caters for a particular set of audiences.
      * @summary Create a plan.
@@ -9076,7 +9189,7 @@ export declare class Cashfree {
     static SubsManageSubscriptionPayment(x_api_version: string, subscription_id: string, payment_id: string, ManageSubscriptionPaymentRequest: ManageSubscriptionPaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriptionPaymentEntity, any>>;
     /**
      * Use this API to upload Physical Nach for Physical Nach Authorization.
-     * @summary Upload Physical Nach for Physical Nach Authorization.
+     * @summary API to upload Physical Nach for Physical Nach Authorization.
      * @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
      * @param {string} payment_id Provide the PaymentId using which the payment was created.
      * @param {File} file Select the .jpg file that should be uploaded or provide the path of that file. You cannot upload a file that is more than 1MB in size.
@@ -9091,7 +9204,7 @@ export declare class Cashfree {
     static SubscriptionDocumentUpload(x_api_version: string, payment_id: string, file: File, payment_id2: string, action: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadPnachImageResponse, any>>;
     /**
      * Use this API to check if a payment method is enabled for your account.
-     * @summary Get Eligible payment methods available for a subscription
+     * @summary API to get all the payment method details available for subscription payments.
      * @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
      * @param {SubscriptionEligibilityRequest} SubscriptionEligibilityRequest Request body to fetch subscription eligibile payment method details.
      * @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree