{ "provider": "Cashfree Payments", "description": "Combined vocabulary from all Cashfree API specifications", "vocabulary": [ { "term": "Orders", "description": "Collection of APIs to handle orders.", "source": "tag" }, { "term": "Payments", "description": "Collection of APIs to handle payments.", "source": "tag" }, { "term": "Refunds", "description": "Collection of APIs to handle refunds.", "source": "tag" }, { "term": "Settlements", "description": "Collection of APIs to handle settlements.", "source": "tag" }, { "term": "Payment Links", "description": "Collection of APIs to handle payment links.", "source": "tag" }, { "term": "Token Vault", "description": "Collection of APIs to use Cashfree's token Vault. This helps you save cards and tokenize them in a PCI-compliant manner. We support the creation of network tokens which can be used across acquiring banks.", "source": "tag" }, { "term": "softPOS", "description": "Collection of APIs to manage the softPOS agent and order", "source": "tag" }, { "term": "Offers", "description": "Collection of APIs to handle offers", "source": "tag" }, { "term": "Eligibility", "description": "Collection of APIs to check eligible entities - payment methods, offers, affordability", "source": "tag" }, { "term": "Settlement Reconciliation", "description": "Collection of APIs to handle settlements", "source": "tag" }, { "term": "PG Reconciliation", "description": "Collection of APIs to handle reconciliation", "source": "tag" }, { "term": "Customers", "description": "Collection of APIs to handle customers.", "source": "tag" }, { "term": "Easy-Split", "description": "Collection of APIs to handle Easy-Split.", "source": "tag" }, { "term": "Simulation", "description": "Collection of APIs to handle simulation.", "source": "tag" }, { "term": "Disputes", "description": "Collection of APIs to handle disputes.", "source": "tag" }, { "term": "Utilities", "description": "Collection of APIs for utility requirements.", "source": "tag" }, { "term": "VendorRecon200Response", "description": "Fetch Vendor Recon details success response.", "source": "schema", "type": "object" }, { "term": "cursor", "description": "", "source": "property", "schema": "VendorRecon200Response" }, { "term": "data", "description": "", "source": "property", "schema": "bavFormDetailSchema" }, { "term": "limit", "description": "", "source": "property", "schema": "VendorRecon200Response" }, { "term": "VendorReconRequest", "description": "Vendor Recon Request body.", "source": "schema", "type": "object" }, { "term": "pagination", "description": "The merchant can set pagination limits based on their use case. The minimum limit is 10. Pagination will fetch a set of records, and the next set of records can be generated using the cursor provided in response to the first request for all reconciliation APIs.", "source": "property", "schema": "VendorReconRequest" }, { "term": "filters", "description": "Specify the filters for the desired use case.", "source": "property", "schema": "VendorReconRequest" }, { "term": "UploadTerminalDocsEntity", "description": "Upload the terminal documents.", "source": "schema", "type": "object" }, { "term": "cf_terminal_id", "description": "", "source": "property", "schema": "UploadTerminalDocsEntity" }, { "term": "doc_type", "description": "", "source": "property", "schema": "UploadTerminalDocsEntity" }, { "term": "doc_value", "description": "", "source": "property", "schema": "UploadTerminalDocsEntity" }, { "term": "status", "description": "It displays the status of the static link.\nPossible values are:\n- `ACTIVE`", "source": "property", "schema": "GenerateFormLinkQRCodeResponseSchema" }, { "term": "AllOffers", "description": "All offers applicable", "source": "schema", "type": "object" }, { "term": "ApiError", "description": "Error at cashfree's server", "source": "schema", "type": "object" }, { "term": "message", "description": "It displays whether template name is deactivated.", "source": "property", "schema": "DeactivateStaticKYCLinkResponseSchema" }, { "term": "code", "description": "", "source": "property", "schema": "ErrorResponseSchema" }, { "term": "help", "description": "", "source": "property", "schema": "ApiError" }, { "term": "type", "description": "It displays the verification type.", "source": "property", "schema": "aadhaarFormStatusResponseSchema" }, { "term": "ApiError404", "description": "Error when resource requested is not found", "source": "schema", "type": "object" }, { "term": "ApiError409", "description": "duplicate request", "source": "schema", "type": "object" }, { "term": "ApiError502", "description": "Error when there is error at partner bank", "source": "schema", "type": "object" }, { "term": "App", "description": "App payment method", "source": "schema", "type": "object" }, { "term": "channel", "description": "Specify the channel through which the payment must be processed.", "source": "property", "schema": "App" }, { "term": "provider", "description": "Specify the provider through which the payment must be processed.", "source": "property", "schema": "App" }, { "term": "phone", "description": "It is the phone number of the individual.", "source": "property", "schema": "GenerateKYCLinkRequestSchema" }, { "term": "AppPaymentMethod", "description": "App payment method", "source": "schema", "type": "object" }, { "term": "app", "description": "", "source": "property", "schema": "AppPaymentMethod" }, { "term": "AuthenticationError", "description": "Error if api keys are wrong", "source": "schema", "type": "object" }, { "term": "AuthorizationInPaymentsEntity", "description": "If preauth enabled for account you will get this body", "source": "schema", "type": "object" }, { "term": "action", "description": "One of CAPTURE or VOID", "source": "property", "schema": "AuthorizationInPaymentsEntity" }, { "term": "captured_amount", "description": "The captured amount for this authorization request", "source": "property", "schema": "AuthorizationInPaymentsEntity" }, { "term": "start_time", "description": "Start time of this authorization hold (only for UPI)", "source": "property", "schema": "AuthorizationInPaymentsEntity" }, { "term": "end_time", "description": "End time of this authorization hold (only for UPI)", "source": "property", "schema": "AuthorizationInPaymentsEntity" }, { "term": "approve_by", "description": "Approve by time as passed in the authorization request (only for UPI)", "source": "property", "schema": "AuthorizationInPaymentsEntity" }, { "term": "action_reference", "description": "CAPTURE or VOID reference number based on action ", "source": "property", "schema": "AuthorizationInPaymentsEntity" }, { "term": "action_time", "description": "Time of action (CAPTURE or VOID)", "source": "property", "schema": "AuthorizationInPaymentsEntity" }, { "term": "AuthorizeOrderRequest", "description": "Request to capture or void transaction", "source": "schema", "type": "object" }, { "term": "amount", "description": "Amount to be transferred, >= 1.00", "source": "property", "schema": "v1_createCashgram_body" }, { "term": "BadRequestError", "description": "Invalid request received from client", "source": "schema", "type": "object" }, { "term": "Card", "description": "Card Payment method", "source": "schema", "type": "object" }, { "term": "card_number", "description": "Customer card number for plain card transactions. Token pan number for tokenized card transactions.", "source": "property", "schema": "Card" }, { "term": "card_holder_name", "description": "Customer name mentioned on the card.", "source": "property", "schema": "Card" }, { "term": "card_expiry_mm", "description": "Card expiry month for plain card transactions. Token expiry month for tokenized card transactions.", "source": "property", "schema": "Card" }, { "term": "card_expiry_yy", "description": "Card expiry year for plain card transactions. Token expiry year for tokenized card transactions.", "source": "property", "schema": "Card" }, { "term": "card_cvv", "description": "CVV mentioned on the card.", "source": "property", "schema": "Card" }, { "term": "instrument_id", "description": "instrument id of saved card. Required only to make payment using saved instrument.", "source": "property", "schema": "Card" }, { "term": "cryptogram", "description": "cryptogram received from card network. Required only for tokenized card transactions.", "source": "property", "schema": "Card" }, { "term": "token_requestor_id", "description": "TRID issued by card networks. Required only for tokenized card transactions.", "source": "property", "schema": "Card" }, { "term": "token_reference_id", "description": "Token Reference Id provided by Diners for Guest Checkout Token. Required only for Diners cards.", "source": "property", "schema": "Card" }, { "term": "token_type", "description": "", "source": "property", "schema": "Card" }, { "term": "card_display", "description": "last 4 digits of original card number. Required only for tokenized card transactions.", "source": "property", "schema": "Card" }, { "term": "card_alias", "description": "Card alias as returned by Cashfree Vault API.", "source": "property", "schema": "Card" }, { "term": "card_bank_name", "description": "One of [\"Kotak\", \"ICICI\", \"RBL\", \"BOB\", \"Standard Chartered\"]. Card bank name, required for EMI payments. This is the bank user has selected for EMI", "source": "property", "schema": "Card" }, { "term": "address_line_one", "description": "First line of the address.", "source": "property", "schema": "Card" }, { "term": "address_line_two", "description": "Second line of the address.", "source": "property", "schema": "Card" }, { "term": "city", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "zip_code", "description": "Pin Code/Zip Code.", "source": "property", "schema": "Card" }, { "term": "country", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "country_code", "description": "It displays the country code associated with the geographical location of the device or network to which the IP address is assigned.", "source": "property", "schema": "IpVerificationResponseSchema" }, { "term": "state", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "state_code", "description": "State Code. Should be in ISO 2 format (ie. FL for Florida)", "source": "property", "schema": "Card" }, { "term": "emi_tenure", "description": "EMI tenure selected by the user", "source": "property", "schema": "Card" }, { "term": "CardArray", "description": "short code for credit card, debit card, prepaid card", "source": "schema", "type": "string" }, { "term": "CardEMI", "description": "Payment method for card emi", "source": "schema", "type": "object" }, { "term": "CardEMIPaymentMethod", "description": "Complete card emi payment method", "source": "schema", "type": "object" }, { "term": "emi", "description": "", "source": "property", "schema": "CardEMIPaymentMethod" }, { "term": "CardPaymentMethod", "description": "The card payment object is used to make payment using either plain card number, saved card instrument id or using cryptogram", "source": "schema", "type": "object" }, { "term": "card", "description": "It displays the status of card.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "CardlessEMI", "description": "Request body for cardless emi payment method", "source": "schema", "type": "object" }, { "term": "CardlessEMIEntity", "description": "cardless EMI object", "source": "schema", "type": "object" }, { "term": "payment_method", "description": "", "source": "property", "schema": "CardlessEMIEntity" }, { "term": "emi_plans", "description": "", "source": "property", "schema": "CardlessEMIEntity" }, { "term": "CardlessEMIPaymentMethod", "description": "cardless EMI payment method object", "source": "schema", "type": "object" }, { "term": "cardless_emi", "description": "", "source": "property", "schema": "CardlessEMIPaymentMethod" }, { "term": "CardlessEMIQueries", "description": "cardless EMI query object", "source": "schema", "type": "object" }, { "term": "order_id", "description": "OrderId of the order. Either of `order_id` or `amount` is mandatory.", "source": "property", "schema": "CardlessEMIQueries" }, { "term": "customer_details", "description": "", "source": "property", "schema": "CardlessEMIQueries" }, { "term": "CashbackDetails", "description": "Cashback detail boject", "source": "schema", "type": "object" }, { "term": "cashback_type", "description": "Type of discount", "source": "property", "schema": "CashbackDetails" }, { "term": "cashback_value", "description": "Value of Discount.", "source": "property", "schema": "CashbackDetails" }, { "term": "max_cashback_amount", "description": "Maximum Value of Cashback allowed.", "source": "property", "schema": "CashbackDetails" }, { "term": "CreateCustomerRequest", "description": "Request body to create a customer at cashfree", "source": "schema", "type": "object" }, { "term": "customer_phone", "description": "Customer Phone Number", "source": "property", "schema": "CreateCustomerRequest" }, { "term": "customer_email", "description": "Customer Email", "source": "property", "schema": "CreateCustomerRequest" }, { "term": "customer_name", "description": "Customer Name", "source": "property", "schema": "CreateCustomerRequest" }, { "term": "SimulateRequest", "description": "simulate payment request object", "source": "schema", "type": "object" }, { "term": "entity", "description": "Entity type should be PAYMENTS or SUBS_PAYMENTS only.", "source": "property", "schema": "SimulateRequest" }, { "term": "entity_id", "description": "If the entity type is PAYMENTS, the entity_id will be the transactionId. If the entity type is SUBS_PAYMENTS, the entity_id will be the merchantTxnId", "source": "property", "schema": "SimulateRequest" }, { "term": "entity_simulation", "description": "", "source": "property", "schema": "SimulateRequest" }, { "term": "CreateLinkRequest", "description": "Request paramenters for link creation", "source": "schema", "type": "object" }, { "term": "link_id", "description": "Unique Identifier (provided by merchant) for the Link. Alphanumeric and only - and _ allowed (50 character limit). Use this for other link-related APIs.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_amount", "description": "Amount to be collected using this link. Provide upto two decimals for paise.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_currency", "description": "Currency for the payment link. Default is INR. Contact care@cashfree.com to enable new currencies.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_purpose", "description": "A brief description for which payment must be collected. This is shown to the customer.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_partial_payments", "description": "If \"true\", customer can make partial payments for the link.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_minimum_partial_amount", "description": "Minimum amount in first installment that needs to be paid by the customer if partial payments are enabled. This should be less than the link_amount.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_expiry_time", "description": "Time after which the link expires. Customers will not be able to make the payment beyond the time specified here. You can provide them in a valid ISO 8601 time format. Default is 30 days.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_notify", "description": "", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_auto_reminders", "description": "If \"true\", reminders will be sent to customers for collecting payments.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_notes", "description": "", "source": "property", "schema": "CreateLinkRequest" }, { "term": "link_meta", "description": "", "source": "property", "schema": "CreateLinkRequest" }, { "term": "order_splits", "description": "If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount.", "source": "property", "schema": "CreateLinkRequest" }, { "term": "CreateOfferRequest", "description": "create offer backend request object", "source": "schema", "type": "object" }, { "term": "offer_meta", "description": "", "source": "property", "schema": "CreateOfferRequest" }, { "term": "offer_tnc", "description": "", "source": "property", "schema": "CreateOfferRequest" }, { "term": "offer_details", "description": "", "source": "property", "schema": "CreateOfferRequest" }, { "term": "offer_validations", "description": "", "source": "property", "schema": "CreateOfferRequest" }, { "term": "CreateOrderRequest", "description": "Request body to create an order at cashfree", "source": "schema", "type": "object" }, { "term": "order_amount", "description": "Bill amount for the order. Provide upto two decimals. 10.15 means Rs 10 and 15 paisa", "source": "property", "schema": "CreateOrderRequest" }, { "term": "order_currency", "description": "Currency for the order. INR if left empty. Contact care@cashfree.com to enable new currencies.", "source": "property", "schema": "CreateOrderRequest" }, { "term": "cart_details", "description": "", "source": "property", "schema": "CreateOrderRequest" }, { "term": "terminal", "description": "", "source": "property", "schema": "CreateOrderRequest" }, { "term": "order_meta", "description": "", "source": "property", "schema": "CreateOrderRequest" }, { "term": "order_expiry_time", "description": "Time after which the order expires. Customers will not be able to make the payment beyond the time specified here. We store timestamps in IST, but you can provide them in a valid ISO 8601 time format. Example 2021-07-02T10:20:12+05:30 for IST, 2021-07-02T10:20:12Z for UTC", "source": "property", "schema": "CreateOrderRequest" }, { "term": "order_note", "description": "Order note for reference.", "source": "property", "schema": "CreateOrderRequest" }, { "term": "order_tags", "description": "", "source": "property", "schema": "CreateOrderRequest" }, { "term": "products", "description": "Use this to set configurations for the products like One Click Checkout, Verify and Pay, if they are enabled for your account", "source": "property", "schema": "CreateOrderRequest" }, { "term": "UpdateOrderExtendedRequest", "description": "Request Body to Update extended data related to order", "source": "schema", "type": "object" }, { "term": "shipment_details", "description": "Shipment details, such as the tracking company, tracking number, and tracking URLs, associated with the shipping of an order. Either `shipment_details` or `order_delivery_status` is required.", "source": "property", "schema": "UpdateOrderExtendedRequest" }, { "term": "order_delivery_status", "description": "", "source": "property", "schema": "UpdateOrderExtendedRequest" }, { "term": "CreateTerminalRequest", "description": "Request body to create a terminal", "source": "schema", "type": "object" }, { "term": "terminal_id", "description": "merchant\u2019s internal terminal id", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "terminal_phone_no", "description": "phone number assigned to the terminal", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "terminal_name", "description": "terminal name to be assigned by merchants", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "terminal_address", "description": "address of the terminal. required for STOREFRONT", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "terminal_email", "description": "terminal email ID of the AGENT/STOREFRONT assigned by merchants.", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "terminal_note", "description": "additional note for terminal", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "terminal_type", "description": "mention the terminal type. possible values - AGENT, STOREFRONT.", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "terminal_meta", "description": "terminal metadata. required field for storefront.", "source": "property", "schema": "CreateTerminalRequest" }, { "term": "CreateTerminalTransactionRequest", "description": "Request body to create a terminal transaction", "source": "schema", "type": "object" }, { "term": "cf_order_id", "description": "cashfree order ID that was returned while creating an order.", "source": "property", "schema": "CreateTerminalTransactionRequest" }, { "term": "add_invoice", "description": "make it true to have request be sent to create a Dynamic GST QR Code.", "source": "property", "schema": "CreateTerminalTransactionRequest" }, { "term": "OnboardSoundboxVpaRequest", "description": "Request body to onboard soundbox vpa", "source": "schema", "type": "object" }, { "term": "vpa", "description": "It displays the UPI VPA associated with the entered mobile number. If no primary UPI VPA is associated, this field will be null.", "source": "property", "schema": "Mobile360ResponseSchema" }, { "term": "device_serial_no", "description": "Device Serial No of soundbox", "source": "property", "schema": "OnboardSoundboxVpaRequest" }, { "term": "merchant_name", "description": "Merchant Name that need to onboard on soundbox", "source": "property", "schema": "OnboardSoundboxVpaRequest" }, { "term": "language", "description": "language of soundbox,currently English, Hindi, Tamil", "source": "property", "schema": "OnboardSoundboxVpaRequest" }, { "term": "UpdateSoundboxVpaRequest", "description": "Request body to update soundbox vpa", "source": "schema", "type": "object" }, { "term": "DemapSoundboxVpaRequest", "description": "Request body to demap soundbox vpa", "source": "schema", "type": "object" }, { "term": "CryptogramEntity", "description": "Crytogram Card object", "source": "schema", "type": "object" }, { "term": "CartDetails", "description": "The cart details that are necessary like shipping address, billing address and more.", "source": "schema", "type": "object" }, { "term": "customer_note", "description": "", "source": "property", "schema": "CartDetails" }, { "term": "shipping_charge", "description": "", "source": "property", "schema": "CartDetails" }, { "term": "cart_name", "description": "Name of the cart.", "source": "property", "schema": "CartDetails" }, { "term": "customer_shipping_address", "description": "", "source": "property", "schema": "CartDetails" }, { "term": "customer_billing_address", "description": "", "source": "property", "schema": "CartDetails" }, { "term": "cart_items", "description": "", "source": "property", "schema": "CartDetails" }, { "term": "CartAddress", "description": "Address given for cart details.", "source": "schema", "type": "object" }, { "term": "full_name", "description": "", "source": "property", "schema": "CartAddress" }, { "term": "pincode", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "address_1", "description": "", "source": "property", "schema": "CartAddress" }, { "term": "address_2", "description": "", "source": "property", "schema": "CartAddress" }, { "term": "CartItem", "description": "Each item in the cart.", "source": "schema", "type": "object" }, { "term": "item_id", "description": "Unique identifier of the item", "source": "property", "schema": "CartItem" }, { "term": "item_name", "description": "Name of the item", "source": "property", "schema": "CartItem" }, { "term": "item_description", "description": "Description of the item", "source": "property", "schema": "CartItem" }, { "term": "item_tags", "description": "Tags attached to that item", "source": "property", "schema": "CartItem" }, { "term": "item_details_url", "description": "Item details url", "source": "property", "schema": "CartItem" }, { "term": "item_image_url", "description": "Item image url", "source": "property", "schema": "CartItem" }, { "term": "item_original_unit_price", "description": "Original price", "source": "property", "schema": "CartItem" }, { "term": "item_discounted_unit_price", "description": "Discounted Price", "source": "property", "schema": "CartItem" }, { "term": "item_currency", "description": "Currency of the item.", "source": "property", "schema": "CartItem" }, { "term": "item_quantity", "description": "Quantity if that item", "source": "property", "schema": "CartItem" }, { "term": "CustomerDetails", "description": "The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.", "source": "schema", "type": "object" }, { "term": "customer_id", "description": "A unique identifier for the customer. Use alphanumeric values only.", "source": "property", "schema": "CustomerDetails" }, { "term": "customer_bank_account_number", "description": "Customer bank account. Required if you want to do a bank account check (TPV)", "source": "property", "schema": "CustomerDetails" }, { "term": "customer_bank_ifsc", "description": "Customer bank IFSC. Required if you want to do a bank account check (TPV)", "source": "property", "schema": "CustomerDetails" }, { "term": "customer_bank_code", "description": "Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV)", "source": "property", "schema": "CustomerDetails" }, { "term": "customer_uid", "description": "Customer identifier at Cashfree. You will get this when you create/get customer", "source": "property", "schema": "CustomerDetails" }, { "term": "CustomerDetailsResponse", "description": "The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.", "source": "schema", "type": "object" }, { "term": "ShipmentDetails", "description": "Shipment details associated with shipping of order like tracking company, tracking number,tracking urls etc.", "source": "schema", "type": "object" }, { "term": "tracking_company", "description": "Tracking company name associated with order.", "source": "property", "schema": "ShipmentDetails" }, { "term": "tracking_urls", "description": "Tracking Urls associated with order.", "source": "property", "schema": "ShipmentDetails" }, { "term": "tracking_numbers", "description": "Tracking Numbers associated wih order.", "source": "property", "schema": "ShipmentDetails" }, { "term": "TerminalData", "description": "Terminal Data in the create order response", "source": "schema", "type": "object" }, { "term": "agent_mobile_number", "description": "", "source": "property", "schema": "TerminalData" }, { "term": "merchant_terminal_id", "description": "", "source": "property", "schema": "TerminalData" }, { "term": "OrderDeliveryStatus", "description": "Order delivery Status associated with order.", "source": "schema", "type": "object" }, { "term": "reason", "description": "It justifies the match score for the API request.", "source": "property", "schema": "NameMatchResponseSchema" }, { "term": "CustomerDetailsCardlessEMI", "description": "Details of the customer for whom eligibility is being checked.", "source": "schema", "type": "object" }, { "term": "CustomerEntity", "description": "The complete customer entity", "source": "schema", "type": "object" }, { "term": "DiscountDetails", "description": "detils of the discount object of offer", "source": "schema", "type": "object" }, { "term": "discount_type", "description": "Type of discount", "source": "property", "schema": "DiscountDetails" }, { "term": "discount_value", "description": "Value of Discount.", "source": "property", "schema": "DiscountDetails" }, { "term": "max_discount_amount", "description": "Maximum Value of Discount allowed.", "source": "property", "schema": "DiscountDetails" }, { "term": "EMIPlansArray", "description": "Single EMI object", "source": "schema", "type": "object" }, { "term": "tenure", "description": "", "source": "property", "schema": "EMIPlansArray" }, { "term": "interest_rate", "description": "", "source": "property", "schema": "EMIPlansArray" }, { "term": "currency", "description": "", "source": "property", "schema": "EMIPlansArray" }, { "term": "total_interest", "description": "", "source": "property", "schema": "EMIPlansArray" }, { "term": "total_amount", "description": "", "source": "property", "schema": "EMIPlansArray" }, { "term": "EligibilityCardlessEMIEntity", "description": "Carless EMI eligible entity", "source": "schema", "type": "object" }, { "term": "eligibility", "description": "", "source": "property", "schema": "EligibilityCardlessEMIEntity" }, { "term": "entity_type", "description": "", "source": "property", "schema": "EligibilityCardlessEMIEntity" }, { "term": "entity_value", "description": "", "source": "property", "schema": "EligibilityCardlessEMIEntity" }, { "term": "entity_details", "description": "", "source": "property", "schema": "EligibilityCardlessEMIEntity" }, { "term": "EligibilityFetchCardlessEMIRequest", "description": "eligibilty request for cardless", "source": "schema", "type": "object" }, { "term": "queries", "description": "", "source": "property", "schema": "EligibilityFetchCardlessEMIRequest" }, { "term": "EligibilityFetchOffersRequest", "description": "Eligiblty API request", "source": "schema", "type": "object" }, { "term": "EligibilityFetchPaylaterRequest", "description": "Request to get eligible paylater payment methods", "source": "schema", "type": "object" }, { "term": "EligibilityFetchPaymentMethodsRequest", "description": "eligibilty request to find eligible payment method", "source": "schema", "type": "object" }, { "term": "EligibilityOfferEntity", "description": "Eligible offer object", "source": "schema", "type": "object" }, { "term": "EligibilityPaylaterEntity", "description": "Eligible paylater payment method", "source": "schema", "type": "object" }, { "term": "EligibilityPaymentMethodsEntity", "description": "Eligible payment methods details", "source": "schema", "type": "object" }, { "term": "InternationalPaymentEntity", "description": "International payment details", "source": "schema", "type": "object" }, { "term": "international", "description": "", "source": "property", "schema": "InternationalPaymentEntity" }, { "term": "ErrorDetailsInPaymentsEntity", "description": "The error details are present only for failed payments", "source": "schema", "type": "object" }, { "term": "error_code", "description": "", "source": "property", "schema": "ErrorDetailsInPaymentsEntity" }, { "term": "error_description", "description": "", "source": "property", "schema": "ErrorDetailsInPaymentsEntity" }, { "term": "error_reason", "description": "", "source": "property", "schema": "ErrorDetailsInPaymentsEntity" }, { "term": "error_source", "description": "", "source": "property", "schema": "ErrorDetailsInPaymentsEntity" }, { "term": "error_code_raw", "description": "", "source": "property", "schema": "ErrorDetailsInPaymentsEntity" }, { "term": "error_description_raw", "description": "", "source": "property", "schema": "ErrorDetailsInPaymentsEntity" }, { "term": "error_subcode_raw", "description": "", "source": "property", "schema": "ErrorDetailsInPaymentsEntity" }, { "term": "FetchReconRequest", "description": "Recon object", "source": "schema", "type": "object" }, { "term": "FetchSettlementsRequest", "description": "Request to fetch settlement", "source": "schema", "type": "object" }, { "term": "FetchTerminalQRCodesEntity", "description": "Fetch Static QR Codes using terminal ID or phone number", "source": "schema", "type": "object" }, { "term": "bank", "description": "It displays the name of the bank.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "qrCode", "description": "Base-64 Encoded QR Code URL", "source": "property", "schema": "FetchTerminalQRCodesEntity" }, { "term": "qrCodeUrl", "description": "URL of the qr Code.", "source": "property", "schema": "FetchTerminalQRCodesEntity" }, { "term": "IdempotencyError", "description": "Error when idempotency fails. Different request body with the same idempotent key", "source": "schema", "type": "object" }, { "term": "InstrumentEntity", "description": "Saved card instrument object", "source": "schema", "type": "object" }, { "term": "afa_reference", "description": "cf_payment_id of the successful transaction done while saving instrument", "source": "property", "schema": "InstrumentEntity" }, { "term": "instrument_type", "description": "Type of the saved instrument", "source": "property", "schema": "InstrumentEntity" }, { "term": "instrument_uid", "description": "Unique id for the saved instrument", "source": "property", "schema": "InstrumentEntity" }, { "term": "instrument_display", "description": "masked card number displayed to the customer", "source": "property", "schema": "InstrumentEntity" }, { "term": "instrument_status", "description": "Status of the saved instrument.", "source": "property", "schema": "InstrumentEntity" }, { "term": "created_at", "description": "Timestamp at which instrument was saved.", "source": "property", "schema": "InstrumentEntity" }, { "term": "instrument_meta", "description": "", "source": "property", "schema": "InstrumentEntity" }, { "term": "InstrumentWebhook", "description": "Instrument webhook object", "source": "schema", "type": "object" }, { "term": "PaymentWebhook", "description": "payment webhook object", "source": "schema", "type": "object" }, { "term": "event_time", "description": "", "source": "property", "schema": "PaymentWebhook" }, { "term": "RefundWebhook", "description": "refund webhook object", "source": "schema", "type": "object" }, { "term": "EntitySimulationRequest", "description": "Entity Simulation it contains payment_status and payment_error_code", "source": "schema", "type": "object" }, { "term": "payment_status", "description": "Payment Status", "source": "property", "schema": "EntitySimulationRequest" }, { "term": "payment_error_code", "description": "Payment Error Code", "source": "property", "schema": "EntitySimulationRequest" }, { "term": "EntitySimulationResponse", "description": "Entity Simulation it contains payment_status and payment_error_code", "source": "schema", "type": "object" }, { "term": "LinkCustomerDetailsEntity", "description": "Payment link customer entity", "source": "schema", "type": "object" }, { "term": "LinkEntity", "description": "Payment link success creation response object", "source": "schema", "type": "object" }, { "term": "cf_link_id", "description": "", "source": "property", "schema": "LinkEntity" }, { "term": "link_status", "description": "", "source": "property", "schema": "LinkEntity" }, { "term": "link_amount_paid", "description": "", "source": "property", "schema": "LinkEntity" }, { "term": "link_created_at", "description": "", "source": "property", "schema": "LinkEntity" }, { "term": "link_url", "description": "", "source": "property", "schema": "LinkEntity" }, { "term": "link_qrcode", "description": "Base64 encoded string for payment link. You can scan with camera to open a link in the browser to complete the payment.", "source": "property", "schema": "LinkEntity" }, { "term": "LinkMetaResponseEntity", "description": "Payment link meta information object", "source": "schema", "type": "object" }, { "term": "notify_url", "description": "Notification URL for server-server communication. It should be an https URL.", "source": "property", "schema": "LinkMetaResponseEntity" }, { "term": "upi_intent", "description": "If \"true\", link will directly open UPI Intent flow on mobile, and normal link flow elsewhere", "source": "property", "schema": "LinkMetaResponseEntity" }, { "term": "return_url", "description": "The URL to which user will be redirected to after the payment is done on the link. Maximum length: 250.", "source": "property", "schema": "LinkMetaResponseEntity" }, { "term": "payment_methods", "description": "Allowed payment modes for this link. Pass comma-separated values among following options - \"cc\", \"dc\", \"ccc\", \"ppc\", \"nb\", \"upi\", \"paypal\", \"app\". Leave it blank to show all available payment methods", "source": "property", "schema": "LinkMetaResponseEntity" }, { "term": "OfferDetailsResponse", "description": "Offer details response and type", "source": "schema", "type": "object" }, { "term": "cashback_details", "description": "", "source": "property", "schema": "OfferDetailsResponse" }, { "term": "discount_details", "description": "", "source": "property", "schema": "OfferDetailsResponse" }, { "term": "offer_type", "description": "Offer Type for the Offer.", "source": "property", "schema": "OfferDetailsResponse" }, { "term": "LinkNotesEntity", "description": "Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs", "source": "schema", "type": "object" }, { "term": "LinkNotifyEntity", "description": "Payment link Notify Object for SMS and Email", "source": "schema", "type": "object" }, { "term": "send_sms", "description": "If \"true\", Cashfree will send sms on customer_phone", "source": "property", "schema": "LinkNotifyEntity" }, { "term": "send_email", "description": "If \"true\", Cashfree will send email on customer_email", "source": "property", "schema": "LinkNotifyEntity" }, { "term": "MethodsType", "description": "Methods Type Object", "source": "schema", "type": "string" }, { "term": "NetBankingPaymentMethod", "description": "Payment method for netbanking object", "source": "schema", "type": "object" }, { "term": "netbanking", "description": "", "source": "property", "schema": "NetBankingPaymentMethod" }, { "term": "Netbanking", "description": "Netbanking payment method request body", "source": "schema", "type": "object" }, { "term": "netbanking_bank_code", "description": "Bank code", "source": "property", "schema": "Netbanking" }, { "term": "netbanking_bank_name", "description": "String code for bank", "source": "property", "schema": "Netbanking" }, { "term": "OfferAll", "description": "returns all offers", "source": "schema", "type": "object" }, { "term": "all", "description": "", "source": "property", "schema": "OfferAll" }, { "term": "OfferCard", "description": "Offers related to cards", "source": "schema", "type": "object" }, { "term": "OfferDetails", "description": "Offer details and type", "source": "schema", "type": "object" }, { "term": "OfferEMI", "description": "EMI offer object", "source": "schema", "type": "object" }, { "term": "OfferEntity", "description": "Offer entity object", "source": "schema", "type": "object" }, { "term": "offer_id", "description": "", "source": "property", "schema": "OfferEntity" }, { "term": "offer_status", "description": "", "source": "property", "schema": "OfferEntity" }, { "term": "payable_amount", "description": "", "source": "property", "schema": "OfferEntity" }, { "term": "OfferValidationsResponse", "description": "Offer validation object", "source": "schema", "type": "object" }, { "term": "max_allowed", "description": "Maximum Amount for Offer to be Applicable", "source": "property", "schema": "OfferValidationsResponse" }, { "term": "min_amount", "description": "Minimum Amount for Offer to be Applicable", "source": "property", "schema": "OfferValidationsResponse" }, { "term": "OfferTncResponse", "description": "Offer terms and condition object", "source": "schema", "type": "object" }, { "term": "offer_tnc_type", "description": "TnC Type for the Offer. It can be either `text` or `link`", "source": "property", "schema": "OfferTncResponse" }, { "term": "offer_tnc_value", "description": "TnC for the Offer.", "source": "property", "schema": "OfferTncResponse" }, { "term": "OfferMetaResponse", "description": "Offer meta response details object", "source": "schema", "type": "object" }, { "term": "offer_code", "description": "Unique identifier for the Offer.", "source": "property", "schema": "OfferMetaResponse" }, { "term": "offer_description", "description": "Description for the Offer.", "source": "property", "schema": "OfferMetaResponse" }, { "term": "offer_end_time", "description": "Expiry Time for the Offer", "source": "property", "schema": "OfferMetaResponse" }, { "term": "offer_start_time", "description": "Start Time for the Offer", "source": "property", "schema": "OfferMetaResponse" }, { "term": "offer_title", "description": "Title for the Offer.", "source": "property", "schema": "OfferMetaResponse" }, { "term": "OfferFilters", "description": "Filter for offers", "source": "schema", "type": "object" }, { "term": "OfferMeta", "description": "Offer meta details object", "source": "schema", "type": "object" }, { "term": "OfferNB", "description": "Offer object ofr NetBanking", "source": "schema", "type": "object" }, { "term": "OfferPaylater", "description": "Offer object for paylater", "source": "schema", "type": "object" }, { "term": "paylater", "description": "", "source": "property", "schema": "OfferPaylater" }, { "term": "OfferQueries", "description": "Offer Query Object", "source": "schema", "type": "object" }, { "term": "OfferTnc", "description": "Offer terms and condition object", "source": "schema", "type": "object" }, { "term": "OfferType", "description": "Offer Type Object", "source": "schema", "type": "string" }, { "term": "OfferUPI", "description": "Offer object for UPI", "source": "schema", "type": "object" }, { "term": "upi", "description": "It displays the UPI VPA information of the individual.", "source": "property", "schema": "GetStatusRpdResponseSchema" }, { "term": "OfferValidations", "description": "Offer validation object", "source": "schema", "type": "object" }, { "term": "OfferWallet", "description": "Offer object for wallet payment method", "source": "schema", "type": "object" }, { "term": "OrderAuthenticateEntity", "description": "This is the response shared when merchant inovkes the OTP submit or resend API", "source": "schema", "type": "object" }, { "term": "cf_payment_id", "description": "The Payment ID for which this request was sent", "source": "property", "schema": "OrderAuthenticateEntity" }, { "term": "authenticate_status", "description": "Status of the is action. Will be either failed or successful. If the action is successful, you should still call the authorization status to verify the final payment status.", "source": "property", "schema": "OrderAuthenticateEntity" }, { "term": "payment_message", "description": "Human readable message which describes the status in more detail", "source": "property", "schema": "OrderAuthenticateEntity" }, { "term": "OrderAuthenticatePaymentRequest", "description": "OTP to be submitted for headless/native OTP", "source": "schema", "type": "object" }, { "term": "otp", "description": "The OTP sent to the mobile number provided in the [Send OTP](https://www.cashfree.com/docs/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-send-otp-request) request.", "source": "property", "schema": "Mobile360VerifyOtpRequestSchema" }, { "term": "OrderCreateRefundRequest", "description": "create refund request object", "source": "schema", "type": "object" }, { "term": "refund_amount", "description": "Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed)", "source": "property", "schema": "OrderCreateRefundRequest" }, { "term": "refund_id", "description": "An unique ID to associate the refund with. Provie alphanumeric values", "source": "property", "schema": "OrderCreateRefundRequest" }, { "term": "refund_note", "description": "A refund note for your reference.", "source": "property", "schema": "OrderCreateRefundRequest" }, { "term": "refund_speed", "description": "Speed at which the refund is processed. It's an optional field with default being STANDARD", "source": "property", "schema": "OrderCreateRefundRequest" }, { "term": "refund_splits", "description": "", "source": "property", "schema": "OrderCreateRefundRequest" }, { "term": "OrderEntity", "description": "The complete order entity", "source": "schema", "type": "object" }, { "term": "order_status", "description": "Possible values are \n- `ACTIVE`: Order does not have a sucessful transaction yet\n- `PAID`: Order is PAID with one successful transaction\n- `EXPIRED`: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order.\n`TERMINATED`: Order terminated\n`TERMINATION_REQUESTED`: Order termination requested", "source": "property", "schema": "OrderEntity" }, { "term": "payment_session_id", "description": "", "source": "property", "schema": "OrderEntity" }, { "term": "terminal_data", "description": "", "source": "property", "schema": "OrderEntity" }, { "term": "OrderExtendedDataEntity", "description": "The complete order extended data entity", "source": "schema", "type": "object" }, { "term": "charges", "description": "", "source": "property", "schema": "OrderExtendedDataEntity" }, { "term": "shipping_address", "description": "", "source": "property", "schema": "OrderExtendedDataEntity" }, { "term": "billing_address", "description": "", "source": "property", "schema": "OrderExtendedDataEntity" }, { "term": "cart", "description": "", "source": "property", "schema": "OrderExtendedDataEntity" }, { "term": "offer", "description": "", "source": "property", "schema": "OrderExtendedDataEntity" }, { "term": "OfferExtendedDetails", "description": "Details of the offer which got applied to the paid order.", "source": "schema", "type": "object" }, { "term": "ExtendedCartDetails", "description": "The cart details that are necessary like shipping address, billing address and more.", "source": "schema", "type": "object" }, { "term": "name", "description": "It is the name of the individual.", "source": "property", "schema": "GenerateKYCLinkRequestSchema" }, { "term": "items", "description": "", "source": "property", "schema": "ExtendedCartDetails" }, { "term": "AddressDetails", "description": "It contains the address information of the individual.", "source": "schema", "type": "object" }, { "term": "pin_code", "description": "Pin Code/Zip Code.", "source": "property", "schema": "AddressDetails" }, { "term": "email", "description": "It is the email address of the individual.", "source": "property", "schema": "GenerateKYCLinkRequestSchema" }, { "term": "ChargesEntity", "description": "Charges accociated with the order", "source": "schema", "type": "object" }, { "term": "shipping_charges", "description": "Shipping charge of the order", "source": "property", "schema": "ChargesEntity" }, { "term": "cod_handling_charges", "description": "COD handling fee for order", "source": "property", "schema": "ChargesEntity" }, { "term": "ExtendedCustomerDetails", "description": "Recent Customer details associated with the order.", "source": "schema", "type": "object" }, { "term": "UpdateOrderExtendedDataEntity", "description": "The complete update order extended data entity", "source": "schema", "type": "object" }, { "term": "CartDetailsEntity", "description": "Cart Details in the Order Entity Response", "source": "schema", "type": "object" }, { "term": "cart_id", "description": "ID of the cart that was created", "source": "property", "schema": "CartDetailsEntity" }, { "term": "OrderMeta", "description": "Optional meta details to control how the customer pays and how payment journey completes", "source": "schema", "type": "object" }, { "term": "payment_methods_filters", "description": "Allowed payment modes for this order. Along with multiple filters for cards can be added to this key. And this filtering will be honoured during transaction creation.", "source": "property", "schema": "OrderMeta" }, { "term": "OrderPayData", "description": "the data object pay api", "source": "schema", "type": "object" }, { "term": "url", "description": "It displays the URL received to retrieve and verify aadhaar information from DigiLocker.", "source": "property", "schema": "DigiLockerVerificationCreateUrlResponseSchema" }, { "term": "payload", "description": "", "source": "property", "schema": "OrderPayData" }, { "term": "content_type", "description": "", "source": "property", "schema": "OrderPayData" }, { "term": "method", "description": "", "source": "property", "schema": "OrderPayData" }, { "term": "redirect_to_bank", "description": "", "source": "property", "schema": "OrderPayData" }, { "term": "OrderTags", "description": "Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added", "source": "schema", "type": "object" }, { "term": "ProductDetailsEntity", "description": "Configurations for this feature", "source": "schema", "type": "object" }, { "term": "enabled", "description": "Whether the feature has been enabled for this order", "source": "property", "schema": "ProductDetailsEntity" }, { "term": "conditions", "description": "Configured condtions for the feature", "source": "property", "schema": "ProductDetailsEntity" }, { "term": "ProductConditionsEntity", "description": "", "source": "schema", "type": "object" }, { "term": "key", "description": "key of the condition", "source": "property", "schema": "ProductConditionsEntity" }, { "term": "values", "description": "Values set for the condition", "source": "property", "schema": "ProductConditionsEntity" }, { "term": "ProductDetails", "description": "Specify the required configurations for this feature", "source": "schema", "type": "object" }, { "term": "ProductConditions", "description": "", "source": "schema", "type": "object" }, { "term": "PayOrderEntity", "description": "Order Pay response once you create a transaction for that order", "source": "schema", "type": "object" }, { "term": "payment_amount", "description": "total amount payable", "source": "property", "schema": "PayOrderEntity" }, { "term": "PayOrderRequest", "description": "Complete object for the pay api that uses payment method objects", "source": "schema", "type": "object" }, { "term": "save_instrument", "description": "", "source": "property", "schema": "PayOrderRequest" }, { "term": "payment_surcharge", "description": "", "source": "property", "schema": "PayOrderRequest" }, { "term": "Paylater", "description": "Paylater payment method", "source": "schema", "type": "object" }, { "term": "Banktransfer", "description": "Banktransfer payment method", "source": "schema", "type": "object" }, { "term": "PaylaterEntity", "description": "Paylater Entity", "source": "schema", "type": "object" }, { "term": "PaylaterPaymentMethod", "description": "paylater payment method", "source": "schema", "type": "object" }, { "term": "BanktransferPaymentMethod", "description": "banktransfer payment method", "source": "schema", "type": "object" }, { "term": "banktransfer", "description": "", "source": "property", "schema": "BanktransferPaymentMethod" }, { "term": "PaymentGatewayDetails", "description": "payment gateway details present in the webhook response", "source": "schema", "type": "object" }, { "term": "gateway_name", "description": "", "source": "property", "schema": "PaymentGatewayDetails" }, { "term": "gateway_order_id", "description": "", "source": "property", "schema": "PaymentGatewayDetails" }, { "term": "gateway_payment_id", "description": "", "source": "property", "schema": "PaymentGatewayDetails" }, { "term": "gateway_order_reference_id", "description": "", "source": "property", "schema": "PaymentGatewayDetails" }, { "term": "gateway_status_code", "description": "", "source": "property", "schema": "PaymentGatewayDetails" }, { "term": "gateway_settlement", "description": "", "source": "property", "schema": "PaymentGatewayDetails" }, { "term": "gateway_reference_name", "description": "", "source": "property", "schema": "PaymentGatewayDetails" }, { "term": "PaymentEntity", "description": "payment entity full object", "source": "schema", "type": "object" }, { "term": "error_details", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "is_captured", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "payment_group", "description": "Type of payment group. One of ['prepaid_card', 'upi_ppi_offline', 'cash', 'upi_credit_card', 'paypal', 'net_banking', 'cardless_emi', 'credit_card', 'bank_transfer', 'pay_later', 'debit_card_emi', 'debit_card', 'wallet', 'upi_ppi', 'upi', 'credit_card_emi']", "source": "property", "schema": "PaymentEntity" }, { "term": "payment_currency", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "payment_time", "description": "This is the time when the payment was initiated", "source": "property", "schema": "PaymentEntity" }, { "term": "payment_completion_time", "description": "This is the time when the payment reaches its terminal state", "source": "property", "schema": "PaymentEntity" }, { "term": "bank_reference", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "auth_id", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "authorization", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "international_payment", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "payment_gateway_details", "description": "", "source": "property", "schema": "PaymentEntity" }, { "term": "TerminalPaymentEntity", "description": "terminal payment entity full object", "source": "schema", "type": "object" }, { "term": "PaymentLinkCustomerDetails", "description": "The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.", "source": "schema", "type": "object" }, { "term": "PaymentLinkOrderEntity", "description": "The complete order entity", "source": "schema", "type": "object" }, { "term": "PaymentMethodAppInPaymentsEntity", "description": "payment method app object in payment entity", "source": "schema", "type": "object" }, { "term": "PaymentMethodBankTransferInPaymentsEntity", "description": "payment method bank transfer object in payment entity", "source": "schema", "type": "object" }, { "term": "PaymentMethodCardEMIInPaymentsEntity", "description": "payment method card emi object in payment entity", "source": "schema", "type": "object" }, { "term": "PaymentMethodCardInPaymentsEntity", "description": "payment method card object in payment entity", "source": "schema", "type": "object" }, { "term": "PaymentMethodCardlessEMIInPaymentsEntity", "description": "payment method carless object in payment entity", "source": "schema", "type": "object" }, { "term": "PaymentMethodNetBankingInPaymentsEntity", "description": "netbanking payment method object for pay", "source": "schema", "type": "object" }, { "term": "PaymentMethodPaylaterInPaymentsEntity", "description": "paylater payment method object for pay api", "source": "schema", "type": "object" }, { "term": "PaymentMethodUPIInPaymentsEntity", "description": "UPI payment method for pay api", "source": "schema", "type": "object" }, { "term": "PaymentMethodsFilters", "description": "Filter for Payment Methods", "source": "schema", "type": "object" }, { "term": "PaymentMethodsQueries", "description": "Payment Method Query Object", "source": "schema", "type": "object" }, { "term": "PaymentModeDetails", "description": "payment mode eligiblity object", "source": "schema", "type": "object" }, { "term": "nick", "description": "", "source": "property", "schema": "PaymentModeDetails" }, { "term": "display", "description": "", "source": "property", "schema": "PaymentModeDetails" }, { "term": "RateLimitError", "description": "Error when rate limit is breached for your api", "source": "schema", "type": "object" }, { "term": "ReconEntity", "description": "Settlement detailed recon response", "source": "schema", "type": "object" }, { "term": "RefundEntity", "description": "The refund entity", "source": "schema", "type": "object" }, { "term": "cf_refund_id", "description": "Cashfree Payments ID for a refund", "source": "property", "schema": "RefundEntity" }, { "term": "refund_currency", "description": "Currency of the refund amount", "source": "property", "schema": "RefundEntity" }, { "term": "refund_status", "description": "This can be one of [\"SUCCESS\", \"PENDING\", \"CANCELLED\", \"ONHOLD\", \"FAILED\"]", "source": "property", "schema": "RefundEntity" }, { "term": "refund_arn", "description": "The bank reference number for refund", "source": "property", "schema": "RefundEntity" }, { "term": "refund_charge", "description": "Charges in INR for processing refund", "source": "property", "schema": "RefundEntity" }, { "term": "status_description", "description": "Description of refund status", "source": "property", "schema": "RefundEntity" }, { "term": "metadata", "description": "", "source": "property", "schema": "Mobile_Record" }, { "term": "refund_type", "description": "This can be one of [\"PAYMENT_AUTO_REFUND\", \"MERCHANT_INITIATED\", \"UNRECONCILED_AUTO_REFUND\"]", "source": "property", "schema": "RefundEntity" }, { "term": "refund_mode", "description": "Method or speed of processing refund", "source": "property", "schema": "RefundEntity" }, { "term": "processed_at", "description": "Time when refund was processed successfully", "source": "property", "schema": "RefundEntity" }, { "term": "forex_conversion_handling_charge", "description": "Cashfree forex conversion charges for refund processing", "source": "property", "schema": "RefundEntity" }, { "term": "forex_conversion_handling_tax", "description": "Cashfree forex conversion tax for refund processing", "source": "property", "schema": "RefundEntity" }, { "term": "forex_conversion_rate", "description": "Cashfree forex conversion rate for refund processing", "source": "property", "schema": "RefundEntity" }, { "term": "charges_currency", "description": "Cashfree refund charges currency for a refund", "source": "property", "schema": "RefundEntity" }, { "term": "RefundSpeed", "description": "How fast refund has to be proecessed", "source": "schema", "type": "object" }, { "term": "requested", "description": "Requested speed of refund.", "source": "property", "schema": "RefundSpeed" }, { "term": "accepted", "description": "Accepted speed of refund.", "source": "property", "schema": "RefundSpeed" }, { "term": "processed", "description": "Processed speed of refund.", "source": "property", "schema": "RefundSpeed" }, { "term": "SavedInstrumentMeta", "description": "Card instrument meta information", "source": "schema", "type": "object" }, { "term": "card_network", "description": "card scheme/network of the saved card. Example visa, mastercard", "source": "property", "schema": "SavedInstrumentMeta" }, { "term": "card_country", "description": "Issuing country of saved card", "source": "property", "schema": "SavedInstrumentMeta" }, { "term": "card_type", "description": "Type of saved card", "source": "property", "schema": "SavedInstrumentMeta" }, { "term": "card_token_details", "description": "", "source": "property", "schema": "SavedInstrumentMeta" }, { "term": "SchemeArray", "description": "array of card schemes like visa, master etc", "source": "schema", "type": "string" }, { "term": "EmptyObject", "description": "", "source": "schema", "type": "object" }, { "term": "SettlementEntity", "description": "Settlement entity object", "source": "schema", "type": "object" }, { "term": "cf_settlement_id", "description": "", "source": "property", "schema": "SettlementEntity" }, { "term": "settlement_currency", "description": "", "source": "property", "schema": "SettlementEntity" }, { "term": "service_charge", "description": "", "source": "property", "schema": "SettlementEntity" }, { "term": "service_tax", "description": "", "source": "property", "schema": "SettlementEntity" }, { "term": "settlement_amount", "description": "", "source": "property", "schema": "SettlementEntity" }, { "term": "settlement_id", "description": "", "source": "property", "schema": "SettlementEntity" }, { "term": "transfer_id", "description": "It is the unique ID you create to identify the transfer. You can use a maximum of 40 characters to create a transfer_id. Alphanumeric and underscore ( _ ) are allowed.", "source": "property", "schema": "CreateTransferRequest" }, { "term": "transfer_time", "description": "", "source": "property", "schema": "SettlementEntity" }, { "term": "transfer_utr", "description": "It displays the unique number that is generated to recognise any fund transfer that is created by the bank that facilitates the transfer.", "source": "property", "schema": "CreateTransferResponse" }, { "term": "VendorBalance", "description": "Vendor Balance entity object", "source": "schema", "type": "object" }, { "term": "merchant_id", "description": "", "source": "property", "schema": "VendorBalance" }, { "term": "vendor_id", "description": "", "source": "property", "schema": "VendorBalance" }, { "term": "merchant_unsettled", "description": "", "source": "property", "schema": "VendorBalance" }, { "term": "vendor_unsettled", "description": "", "source": "property", "schema": "VendorBalance" }, { "term": "VendorBalanceTransferCharges", "description": "Vendor Balance Transfer Charges entity object", "source": "schema", "type": "object" }, { "term": "service_charges", "description": "", "source": "property", "schema": "VendorBalanceTransferCharges" }, { "term": "billed_to", "description": "", "source": "property", "schema": "VendorBalanceTransferCharges" }, { "term": "is_postpaid", "description": "", "source": "property", "schema": "VendorBalanceTransferCharges" }, { "term": "DisputesEntity", "description": "", "source": "schema", "type": "object" }, { "term": "dispute_id", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "dispute_type", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "reason_code", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "reason_description", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "dispute_amount", "description": "Dispute amount may differ from transaction amount for partial cases.", "source": "property", "schema": "DisputesEntity" }, { "term": "dispute_amount_currency", "description": "Dispute amount currency for a dispute", "source": "property", "schema": "DisputesEntity" }, { "term": "respond_by", "description": "This is the time by which evidence should be submitted to contest the dispute.", "source": "property", "schema": "DisputesEntity" }, { "term": "updated_at", "description": "This is the time when the dispute case was updated.", "source": "property", "schema": "DisputesEntity" }, { "term": "resolved_at", "description": "This is the time when the dispute case was closed.", "source": "property", "schema": "DisputesEntity" }, { "term": "dispute_status", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "cf_dispute_remarks", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "preferred_evidence", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "dispute_evidence", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "order_details", "description": "", "source": "property", "schema": "DisputesEntity" }, { "term": "DisputesEntityMerchantAccepted", "description": "", "source": "schema", "type": "object" }, { "term": "OrderDetailsInDisputesEntity", "description": "", "source": "schema", "type": "object" }, { "term": "CustomerDetailsInDisputesEntity", "description": "", "source": "schema", "type": "object" }, { "term": "PreferredEvidence", "description": "", "source": "schema", "type": "array" }, { "term": "DisputeEvidence", "description": "", "source": "schema", "type": "array" }, { "term": "Evidence", "description": "", "source": "schema", "type": "object" }, { "term": "document_id", "description": "It is the unique ID received in the Upload Document for E-Sign API response.", "source": "property", "schema": "ESignVerificationCreateSignatureRequestSchema" }, { "term": "document_name", "description": "", "source": "property", "schema": "Evidence" }, { "term": "document_type", "description": "Tag depicts the document type of the file being shared in the request. Allowed values are PAN, AADHAAR, DRIVING_LICENCE, VOTER_ID, PASSPORT, VEHICLE_RC, CANCELLED_CHEQUE, and INVOICE.", "source": "property", "schema": "BharatOCRRequestSchema" }, { "term": "EvidencesToContestDispute", "description": "", "source": "schema", "type": "object" }, { "term": "document_description", "description": "", "source": "property", "schema": "EvidencesToContestDispute" }, { "term": "VendorEntity", "description": "Vendor entity object", "source": "schema", "type": "object" }, { "term": "added_on", "description": "It displays the date and time of when the request was added.", "source": "property", "schema": "GetStatusRpdResponseSchema" }, { "term": "updated_on", "description": "It displays the updated time for the transfer.", "source": "property", "schema": "CreateTransferResponse" }, { "term": "schedule_option", "description": "", "source": "property", "schema": "VendorEntity" }, { "term": "vendor_type", "description": "", "source": "property", "schema": "VendorEntity" }, { "term": "account_type", "description": "It displays the type of account.", "source": "property", "schema": "GetStatusRpdResponseSchema" }, { "term": "business_type", "description": "", "source": "property", "schema": "VendorEntity" }, { "term": "remarks", "description": "Specify remarks, if any.", "source": "property", "schema": "v1_createCashgram_body" }, { "term": "related_docs", "description": "", "source": "property", "schema": "VendorEntity" }, { "term": "VendorDocumentsResponse", "description": "Get Vendor Documents", "source": "schema", "type": "object" }, { "term": "documents", "description": "", "source": "property", "schema": "VendorDocumentsResponse" }, { "term": "VendorDocumentDownloadResponse", "description": "Download Vendor Document", "source": "schema", "type": "object" }, { "term": "download_url", "description": "", "source": "property", "schema": "VendorDocumentDownloadResponse" }, { "term": "UploadVendorDocumentsResponse", "description": "Upload Vendor Document", "source": "schema", "type": "object" }, { "term": "StaticSplitResponse", "description": "Static Split Response", "source": "schema", "type": "object" }, { "term": "active", "description": "", "source": "property", "schema": "StaticSplitResponse" }, { "term": "terminal_reference_id", "description": "", "source": "property", "schema": "StaticSplitResponse" }, { "term": "product_type", "description": "", "source": "property", "schema": "StaticSplitResponse" }, { "term": "scheme", "description": "", "source": "property", "schema": "StaticSplitResponse" }, { "term": "ESOrderReconResponse", "description": "ES Order Recon Response", "source": "schema", "type": "object" }, { "term": "SplitOrderReconSuccessResponse", "description": "Split Order Reconciliation Request Body", "source": "schema", "type": "object" }, { "term": "settlement", "description": "Details of the settlement information.", "source": "property", "schema": "SplitOrderReconSuccessResponse" }, { "term": "refunds", "description": "List of refunds associated with the order, if any.", "source": "property", "schema": "SplitOrderReconSuccessResponse" }, { "term": "vendors", "description": "List of vendor settlements associated with the split settlement.", "source": "property", "schema": "SplitOrderReconSuccessResponse" }, { "term": "SimulationResponse", "description": "Simulation response object", "source": "schema", "type": "object" }, { "term": "simulation_id", "description": "", "source": "property", "schema": "SimulationResponse" }, { "term": "SplitAfterPaymentResponse", "description": "Split After Payment Response", "source": "schema", "type": "object" }, { "term": "AdjustVendorBalanceResponse", "description": "Adjust Vendor Balance Response", "source": "schema", "type": "object" }, { "term": "transfer_details", "description": "", "source": "property", "schema": "AdjustVendorBalanceResponse" }, { "term": "balances", "description": "", "source": "property", "schema": "AdjustVendorBalanceResponse" }, { "term": "VendorAdjustmentSuccessResponse", "description": "Vendor Adjustment Success Response", "source": "schema", "type": "object" }, { "term": "CreateVendorResponse", "description": "Create Vendor Response", "source": "schema", "type": "object" }, { "term": "kyc_details", "description": "", "source": "property", "schema": "CreateVendorResponse" }, { "term": "dashboard_access", "description": "", "source": "property", "schema": "CreateVendorResponse" }, { "term": "bank_details", "description": "", "source": "property", "schema": "CreateVendorResponse" }, { "term": "UpdateVendorResponse", "description": "Update Vendor Response", "source": "schema", "type": "object" }, { "term": "CreateVendorRequest", "description": "Create Vendor Request", "source": "schema", "type": "object" }, { "term": "verify_account", "description": "Specify if the vendor bank account details should be verified. Possible values: true or false", "source": "property", "schema": "CreateVendorRequest" }, { "term": "StaticSplitRequest", "description": "Static Split Request", "source": "schema", "type": "object" }, { "term": "ESOrderReconRequest", "description": "ES Order Recon Request", "source": "schema", "type": "object" }, { "term": "SplitAfterPaymentRequest", "description": "Split After Payment Request", "source": "schema", "type": "object" }, { "term": "split", "description": "Specify the vendors order split details.", "source": "property", "schema": "SplitAfterPaymentRequest" }, { "term": "disable_split", "description": "Specify if you want to end the split or continue creating further splits in future.", "source": "property", "schema": "SplitAfterPaymentRequest" }, { "term": "AdjustVendorBalanceRequest", "description": "Adjust Vendor Balance Request", "source": "schema", "type": "object" }, { "term": "transfer_from", "description": "Mention to whom you want to transfer the on demand balance. Possible values - MERCHANT, VENDOR.", "source": "property", "schema": "AdjustVendorBalanceRequest" }, { "term": "transfer_type", "description": "Mention the type of transfer. Possible values: ON_DEMAND.", "source": "property", "schema": "AdjustVendorBalanceRequest" }, { "term": "transfer_amount", "description": "It is the transfer amount. Decimal values are allowed. The minimum value should be equal to or greater than 1.00. (>= 1.00)", "source": "property", "schema": "CreateTransferRequest" }, { "term": "remark", "description": "Mention remarks if any for the on demand transfer.", "source": "property", "schema": "AdjustVendorBalanceRequest" }, { "term": "tags", "description": "Provide additional data fields using tags.", "source": "property", "schema": "AdjustVendorBalanceRequest" }, { "term": "VendorAdjustmentRequest", "description": "Vendor Adjustment Request Body", "source": "schema", "type": "object" }, { "term": "adjustment_id", "description": "The unique identifier for the adjustment transaction.", "source": "property", "schema": "VendorAdjustmentRequest" }, { "term": "UpdateVendorRequest", "description": "Update Vendor Request", "source": "schema", "type": "object" }, { "term": "CreateOrderSettlementRequestBody", "description": "Create Order Settlement Object", "source": "schema", "type": "object" }, { "term": "meta_data", "description": "", "source": "property", "schema": "CreateOrderSettlementRequestBody" }, { "term": "SettlementFetchReconRequest", "description": "Recon Request Object", "source": "schema", "type": "object" }, { "term": "SettlementReconEntity", "description": "Recon object for settlement", "source": "schema", "type": "object" }, { "term": "SettlementWebhook", "description": "Settlement webhook object", "source": "schema", "type": "object" }, { "term": "TerminalDetails", "description": "Use this if you are creating an order for cashfree's softPOS", "source": "schema", "type": "object" }, { "term": "last_updated_on", "description": "last instant when this terminal was updated", "source": "property", "schema": "TerminalDetails" }, { "term": "terminal_status", "description": "status of terminal active/inactive", "source": "property", "schema": "TerminalDetails" }, { "term": "TerminalEntity", "description": "Create terminal response object", "source": "schema", "type": "object" }, { "term": "teminal_id", "description": "", "source": "property", "schema": "TerminalEntity" }, { "term": "TerminalTransactionEntity", "description": "Create terminal response object", "source": "schema", "type": "object" }, { "term": "payment_url", "description": "", "source": "property", "schema": "TerminalTransactionEntity" }, { "term": "qrcode", "description": "", "source": "property", "schema": "TerminalTransactionEntity" }, { "term": "timeout", "description": "", "source": "property", "schema": "TerminalTransactionEntity" }, { "term": "SoundboxVpaEntity", "description": "soundbox response object", "source": "schema", "type": "object" }, { "term": "TerminateOrderRequest", "description": "Request to terminate an active order at Cashfree", "source": "schema", "type": "object" }, { "term": "UPIAuthorizeDetails", "description": "object when you are using preauth in UPI in order pay", "source": "schema", "type": "object" }, { "term": "UPIPaymentMethod", "description": "Complete payment method for UPI collect", "source": "schema", "type": "object" }, { "term": "UpdateTerminalEntity", "description": "Update terminal response", "source": "schema", "type": "object" }, { "term": "UpdateTerminalRequest", "description": "Request body to update terminal details.", "source": "schema", "type": "object" }, { "term": "UpdateTerminalStatusRequest", "description": "Request body to update terminal status.", "source": "schema", "type": "object" }, { "term": "Upi", "description": "UPI collect payment method object", "source": "schema", "type": "object" }, { "term": "upi_id", "description": "Customer UPI VPA to process payment. \n### Important\nThis is a required parameter for channel = `collect`\n", "source": "property", "schema": "Upi" }, { "term": "upi_redirect_url", "description": "use this if you want cashfree to show a loader. Sample response below. It is only supported for collect\n`action:collect` will be returned with `data.url` having the link for redirection\n", "source": "property", "schema": "Upi" }, { "term": "upi_expiry_minutes", "description": "The UPI request will be valid for this expiry minutes. This parameter is only applicable for a UPI collect payment. The default value is 5 minutes. You should keep the minimum as 5 minutes, and maximum as 15 minutes", "source": "property", "schema": "Upi" }, { "term": "authorize_only", "description": "For one time mandate on UPI, set this as authorize_only = true.", "source": "property", "schema": "Upi" }, { "term": "UploadTerminalDocs", "description": "Request body to upload terminal documents.", "source": "schema", "type": "object" }, { "term": "file", "description": "Image of the document. Allowed file types: JPEG, JPG, or PNG. The maximum file size is 5 MB. Conditionally required when image_url is missing.", "source": "property", "schema": "BharatOCRRequestSchema" }, { "term": "VendorSplit", "description": "Use to split order when cashfree's Easy Split is enabled for your account.", "source": "schema", "type": "object" }, { "term": "percentage", "description": "Percentage of order amount which shall get added to vendor account", "source": "property", "schema": "VendorSplit" }, { "term": "BankDetails", "description": "", "source": "schema", "type": "object" }, { "term": "account_number", "description": "", "source": "property", "schema": "BankDetails" }, { "term": "account_holder", "description": "", "source": "property", "schema": "BankDetails" }, { "term": "ifsc", "description": "It is the IFSC information of the bank where the bank account is registered. It should be ann alphanumeric value of 11 characters. The first 4 characters should be alphabets, the 5th character should be a 0, and the remaining 6 characters should be numeric digits.", "source": "property", "schema": "BankAccountVerificationAsyncRequestSchema" }, { "term": "TransferDetails", "description": "", "source": "schema", "type": "object" }, { "term": "BalanceDetails", "description": "", "source": "schema", "type": "object" }, { "term": "ChargesDetails", "description": "", "source": "schema", "type": "object" }, { "term": "UpiDetails", "description": "", "source": "schema", "type": "object" }, { "term": "KycDetails", "description": "", "source": "schema", "type": "object" }, { "term": "uidai", "description": "", "source": "property", "schema": "KycDetails" }, { "term": "gst", "description": "", "source": "property", "schema": "KycDetails" }, { "term": "cin", "description": "It is the unique alphanumeric identifier assigned to companies registered under the Ministry of Corporate Affairs, India.", "source": "property", "schema": "CinRequestSchema" }, { "term": "pan", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "passport_number", "description": "", "source": "property", "schema": "KycDetails" }, { "term": "driving_license", "description": "", "source": "property", "schema": "KycDetails" }, { "term": "voter_id", "description": "", "source": "property", "schema": "KycDetails" }, { "term": "ScheduleOption", "description": "", "source": "schema", "type": "object" }, { "term": "settlement_schedule_message", "description": "", "source": "property", "schema": "ScheduleOption" }, { "term": "schedule_id", "description": "", "source": "property", "schema": "ScheduleOption" }, { "term": "merchant_default", "description": "", "source": "property", "schema": "ScheduleOption" }, { "term": "SubscriptionPaymentSplitItem", "description": "Subscription Payment Split Item", "source": "schema", "type": "object" }, { "term": "AuthorizationDetails", "description": "Details of the authorization done for the subscription. Returned in Get subscription and auth payments.", "source": "schema", "type": "object" }, { "term": "authorization_amount", "description": "Authorization amount for the auth payment.", "source": "property", "schema": "AuthorizationDetails" }, { "term": "authorization_amount_refund", "description": "Indicates whether the authorization amount should be refunded to the customer automatically. Merchants can use this field to specify if the authorized funds should be returned to the customer after authorization of the subscription.", "source": "property", "schema": "AuthorizationDetails" }, { "term": "authorization_reference", "description": "Authorization reference. UMN for UPI, UMRN for EMandate/Physical Mandate and Enrollment ID for cards.", "source": "property", "schema": "AuthorizationDetails" }, { "term": "authorization_time", "description": "Authorization time.", "source": "property", "schema": "AuthorizationDetails" }, { "term": "authorization_status", "description": "Status of the authorization.", "source": "property", "schema": "AuthorizationDetails" }, { "term": "payment_id", "description": "A unique ID passed by merchant for identifying the transaction.", "source": "property", "schema": "AuthorizationDetails" }, { "term": "SubscriptionCustomerDetails", "description": "Subscription customer details.", "source": "schema", "type": "object" }, { "term": "customer_bank_account_holder_name", "description": "Bank holder name of the customer.", "source": "property", "schema": "SubscriptionCustomerDetails" }, { "term": "customer_bank_account_type", "description": "Bank account type of the customer.", "source": "property", "schema": "SubscriptionCustomerDetails" }, { "term": "PlanEntity", "description": "The response returned for Get, Create and Manage Plan APIs", "source": "schema", "type": "object" }, { "term": "plan_currency", "description": "Currency for the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_id", "description": "Plan ID provided by merchant.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_interval_type", "description": "Interval type for the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_intervals", "description": "Number of intervals for the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_max_amount", "description": "Maximum amount for the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_max_cycles", "description": "Maximum number of payment cycles for the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_name", "description": "Name of the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_note", "description": "Note for the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_recurring_amount", "description": "Recurring amount for the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_status", "description": "Status of the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "plan_type", "description": "Type of the plan.", "source": "property", "schema": "PlanEntity" }, { "term": "SubscriptionEntity", "description": "The response returned for Get, Create or Manage Subscription APIs.", "source": "schema", "type": "object" }, { "term": "authorisation_details", "description": "", "source": "property", "schema": "SubscriptionEntity" }, { "term": "cf_subscription_id", "description": "Cashfree subscription reference number", "source": "property", "schema": "SubscriptionEntity" }, { "term": "plan_details", "description": "", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_expiry_time", "description": "Time at which the subscription will expire.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_first_charge_time", "description": "Time at which the first charge will be made for the subscription. Applicable only for PERIODIC plans.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_id", "description": "A unique ID passed by merchant for identifying the subscription.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_meta", "description": "Subscription metadata.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_note", "description": "Note for the subscription.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_session_id", "description": "Subscription Session Id.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_payment_splits", "description": "Payment splits for the subscription.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_status", "description": "Status of the subscription.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "subscription_tags", "description": "Tags for the subscription.", "source": "property", "schema": "SubscriptionEntity" }, { "term": "SubscriptionPaymentEntity", "description": "The response returned in Get, Create or Manage Subscription Payment APIs.", "source": "schema", "type": "object" }, { "term": "authorization_details", "description": "", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "cf_txn_id", "description": "Cashfree subscription payment transaction ID", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "failure_details", "description": "", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "payment_initiated_date", "description": "The date on which the payment was initiated.", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "payment_remarks", "description": "Payment remarks.", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "payment_schedule_date", "description": "The date on which the payment is scheduled to be processed.", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "payment_type", "description": "Payment type. Can be AUTH or CHARGE.", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "retry_attempts", "description": "Retry attempts.", "source": "property", "schema": "SubscriptionPaymentEntity" }, { "term": "CreateSubscriptionPaymentResponse", "description": "The response returned is Create Subscription Auth or Charge APIs.", "source": "schema", "type": "object" }, { "term": "SubscriptionPaymentRefundEntity", "description": "Get/Create Subscription Payment Refund Response", "source": "schema", "type": "object" }, { "term": "CreateSubscriptionRefundRequest", "description": "Request body to create a subscription refund.", "source": "schema", "type": "object" }, { "term": "CreatePlanRequest", "description": "Request body to create a plan.", "source": "schema", "type": "object" }, { "term": "ManageSubscriptionRequest", "description": "Request body to manage a subscription.", "source": "schema", "type": "object" }, { "term": "action_details", "description": "Details of the action to be performed.", "source": "property", "schema": "ManageSubscriptionRequest" }, { "term": "CreateSubscriptionRequest", "description": "Request body to create a new subscription.", "source": "schema", "type": "object" }, { "term": "ManageSubscriptionPaymentRequest", "description": "Request body to manage a subscription payment.", "source": "schema", "type": "object" }, { "term": "CreateSubscriptionPaymentRequest", "description": "The request to be passed for the create subscription payment API.", "source": "schema", "type": "object" }, { "term": "CreateSubscriptonPaymentRequestUpi", "description": "payment method upi.", "source": "schema", "type": "object" }, { "term": "CreateSubscriptionPaymentRequestCard", "description": "payment method card.", "source": "schema", "type": "object" }, { "term": "CreateSubscriptionPaymentRequestEnach", "description": "payment method enach.", "source": "schema", "type": "object" }, { "term": "account_bank_code", "description": "Account bank code (required without AccountIFSC)", "source": "property", "schema": "CreateSubscriptionPaymentRequestEnach" }, { "term": "account_holder_name", "description": "Account holder name", "source": "property", "schema": "CreateSubscriptionPaymentRequestEnach" }, { "term": "account_ifsc", "description": "Account IFSC", "source": "property", "schema": "CreateSubscriptionPaymentRequestEnach" }, { "term": "auth_mode", "description": "Authentication mode. can be debit_card, aadhaar, or net_banking", "source": "property", "schema": "CreateSubscriptionPaymentRequestEnach" }, { "term": "CreateSubscriptionPaymentRequestPnach", "description": "payment method pnach.", "source": "schema", "type": "object" }, { "term": "mandate_creation_date", "description": "Mandate creation date", "source": "property", "schema": "CreateSubscriptionPaymentRequestPnach" }, { "term": "mandate_start_date", "description": "Mandate start date", "source": "property", "schema": "CreateSubscriptionPaymentRequestPnach" }, { "term": "UploadPnachImageRequest", "description": "Request Body to upload Physical Nach Image.", "source": "schema", "type": "object" }, { "term": "UploadPnachImageResponse", "description": "Response of pnach image upload API.", "source": "schema", "type": "object" }, { "term": "SubscriptionEligibilityRequest", "description": "Request body to fetch subscription eligibile payment method details.", "source": "schema", "type": "object" }, { "term": "SubscriptionBankDetails", "description": "Bank details object", "source": "schema", "type": "object" }, { "term": "bank_id", "description": "ID of the bank.", "source": "property", "schema": "SubscriptionBankDetails" }, { "term": "bank_name", "description": "It displays the name of the bank.", "source": "property", "schema": "BAVV2ValidationSuccessfulSchema" }, { "term": "account_auth_modes", "description": "List of account authentication modes supported by the bank. (e.g. DEBIT_CARD, NET_BANKING, AADHAAR)", "source": "property", "schema": "SubscriptionBankDetails" }, { "term": "EligibilityMethodItem", "description": "Eligibile payment method object", "source": "schema", "type": "object" }, { "term": "SubscriptionEligibilityResponse", "description": "Subscrition eligibility API response", "source": "schema", "type": "object" }, { "term": "PARRequest", "description": "", "source": "schema", "type": "object" }, { "term": "PGEligibilityFetchPaymentMethods", "description": "Use this API to get eligible Payment Methods", "source": "operation" }, { "term": "PGCreateLink", "description": "Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url. Please pass non required fields only if user passed that are critical like phone", "source": "operation" }, { "term": "PGFetchLink", "description": "Use this API to view all details and status of a payment link.", "source": "operation" }, { "term": "PGCancelLink", "description": "Use this API to cancel a payment link. No further payments can be done against a cancelled link. Only a link in ACTIVE status can be cancelled.", "source": "operation" }, { "term": "PGLinkFetchOrders", "description": "Use this API to view all order details for a payment link.", "source": "operation" }, { "term": "PGCreateOrder", "description": "### Order\nAn order is an entity which has a amount and currency associated with it. It is something for which you want to collect payment for.\nUse this API to create orders with Cashfree from your backend to get a `payment_sessions_id`. \nYou can use the `payment_sessions_id` to create a transaction for the order.\n", "source": "operation" }, { "term": "PGFetchOrder", "description": "Use this API to fetch the order that was created at Cashfree's using the `order_id`. \n## When to use this API\n- To check the status of your order\n- Once the order is PAID\n- Once your customer returns to `return_url`\n", "source": "operation" }, { "term": "PGTerminateOrder", "description": "Use this API to terminate the order that was created at Cashfree's using the `order_id`.", "source": "operation" }, { "term": "PGFetchOrderExtendedData", "description": "Use this API to fetch the order related data like address,cart,offers,customer details etc using the Cashfree's `order_id`.\n## When to use this API\n- To get the extended data associated with order.\n- Once the order is PAID\n- Once your customer returns to `return_url`\n", "source": "operation" }, { "term": "PGOrderFetchPayments", "description": "Use this API to view all payment details for an order.", "source": "operation" }, { "term": "PGOrderFetchPayment", "description": "Use this API to view payment details of an order for a Payment ID.", "source": "operation" }, { "term": "PGOrderFetchRefunds", "description": "Use this API to fetch all refunds processed against an order.", "source": "operation" }, { "term": "PGOrderCreateRefund", "description": "Use this API to initiate refunds.", "source": "operation" }, { "term": "PGOrderFetchRefund", "description": "Use this API to fetch a specific refund processed on your Cashfree Account.", "source": "operation" }, { "term": "PGFetchSettlements", "description": "Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range.", "source": "operation" }, { "term": "PGOrderFetchSettlement", "description": "Use this API to view all the settlements of a particular order.", "source": "operation" }, { "term": "PGFetchOrderDisputes", "description": "Use this API to get all Dispute details by specifying the Order ID.", "source": "operation" }, { "term": "PGFetchPaymentDisputes", "description": "Use this API to get all Dispute details by specifying the Payment ID.", "source": "operation" }, { "term": "PGFetchDisputeByID", "description": "Use this API to get Dispute details by specifying the Dispute ID.", "source": "operation" }, { "term": "PGAcceptDisputeByID", "description": "Use this API to get accept the Dispute by specifying the Dispute ID.", "source": "operation" }, { "term": "PGUploadDisputesDocuments", "description": "Use this API to Submit the Evidences to contest the Dispute by specifying the Dispute ID.", "source": "operation" }, { "term": "PGSimulatePayment", "description": "Use this API to simulate payment. To use this API you should first create an order using the Create Order API. Also, you need to create a payment with the same order.", "source": "operation" }, { "term": "PGFetchSimulation", "description": "Use this API to fetch simulated payment details.", "source": "operation" }, { "term": "PGESOrderRecon", "description": "Use this API to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date.", "source": "operation" }, { "term": "V2 Apis", "description": "Collection of APIs to transfer funds to beneficiaries and manage beneficiaries.", "source": "tag" }, { "term": "ErrorV2", "description": "Error Response for non-2XX cases", "source": "schema", "type": "object" }, { "term": "Beneficiary", "description": "Contains the information of the created beneficiary", "source": "schema", "type": "object" }, { "term": "beneficiary_id", "description": "It displays the unique Id you created to identify the beneficiary.", "source": "property", "schema": "Beneficiary" }, { "term": "beneficiary_name", "description": "It displays the name of the beneficiary.", "source": "property", "schema": "Beneficiary" }, { "term": "beneficiary_instrument_details", "description": "It displays the payment instrument details of the beneficiary.", "source": "property", "schema": "Beneficiary" }, { "term": "beneficiary_contact_details", "description": "It displays the contact details of the beneficiary.", "source": "property", "schema": "Beneficiary" }, { "term": "beneficiary_status", "description": "It displays the current status of the beneficiary. Possible values are as follows\n- `VERIFIED`: Beneficiary is verified and is available for payouts\n- `INVALID`: Beneficiary is invalid\n- `INITIATED`: Beneficiary verification initiated\n- `CANCELLED`: Beneficiary verification cancelled\n- `FAILED`: Failed to verify beneficiary\n- `DELETED`: Beneficiary is deleted", "source": "property", "schema": "Beneficiary" }, { "term": "CreateBeneficiaryRequest", "description": "Find the request parameters to create a beneficiary", "source": "schema", "type": "object" }, { "term": "CreateTransferRequest", "description": "Standard Transfer V2", "source": "schema", "type": "object" }, { "term": "transfer_currency", "description": "It is the currency of the transfer amount. The default value is INR.", "source": "property", "schema": "CreateTransferRequest" }, { "term": "transfer_mode", "description": "It is the mode of transfer. Allowed values are banktransfer, imps, neft, rtgs, upi, paytm, amazonpay, card. The default transfer_mode is banktransfer.", "source": "property", "schema": "CreateTransferRequest" }, { "term": "beneficiary_details", "description": "It should contain the details of the beneficiary who receives the transfer amount.", "source": "property", "schema": "CreateTransferRequest" }, { "term": "transfer_remarks", "description": "It can contain any additional remarks for the transfer. Alphanumeric and whitespaces are allowed. The maximum character limit is 70.", "source": "property", "schema": "CreateTransferRequest" }, { "term": "fundsource_id", "description": "It is the ID of the fund source from which the transfer amount will be debited.", "source": "property", "schema": "CreateTransferRequest" }, { "term": "CreateBatchTransferRequest", "description": "Batch Transfer V2", "source": "schema", "type": "object" }, { "term": "batch_transfer_id", "description": "It is the unique ID you create to identify the batch transfer request. The maximum character limit is 60. Alphanumeric and underscore ( _ ) characters are allowed.", "source": "property", "schema": "CreateBatchTransferRequest" }, { "term": "transfers", "description": "", "source": "property", "schema": "CreateBatchTransferRequest" }, { "term": "CreateTransferResponse", "description": "Standard Transfer V2 Response", "source": "schema", "type": "object" }, { "term": "cf_transfer_id", "description": "It displays the unique ID created by Cashfree Payments. You receive this ID in the response after initiating the standard transfer request.", "source": "property", "schema": "CreateTransferResponse" }, { "term": "transfer_service_charge", "description": "It displays the service charge applicable for the successful transfer request.", "source": "property", "schema": "CreateTransferResponse" }, { "term": "transfer_service_tax", "description": "It displays the service tax applicable for the successful transfer request.", "source": "property", "schema": "CreateTransferResponse" }, { "term": "CreateBatchTransferResponse", "description": "Batch Transfer V2 Response", "source": "schema", "type": "object" }, { "term": "cf_batch_transfer_id", "description": "It displays the unique ID created by Cashfree Payments. You receive this ID in the response after initiating the batch transfer request.", "source": "property", "schema": "CreateBatchTransferResponse" }, { "term": "FetchBatchTransferResponse", "description": "Batch Transfer Status V2 Response", "source": "schema", "type": "object" }, { "term": "inline_response_401", "description": "", "source": "schema", "type": "object" }, { "term": "subCode", "description": "", "source": "property", "schema": "bavFormDetailSchema" }, { "term": "inline_response_200_10", "description": "", "source": "schema", "type": "object" }, { "term": "v1_createCashgram_body", "description": "", "source": "schema", "type": "object" }, { "term": "cashgramId", "description": "Unique Id of the Cashgram. Alphanumeric, underscore (_), and hyphen (-) allowed (35 character limit)", "source": "property", "schema": "v1_createCashgram_body" }, { "term": "linkExpiry", "description": "Date to expire the cashgram link, Date format YYYY/MM/DD, maximum 30 days from the date of creation.", "source": "property", "schema": "v1_createCashgram_body" }, { "term": "notifyCustomer", "description": "If value is 1, a link is sent to customers phone and email.", "source": "property", "schema": "v1_createCashgram_body" }, { "term": "inline_response_200_8", "description": "", "source": "schema", "type": "object" }, { "term": "inline_response_409_1", "description": "", "source": "schema", "type": "object" }, { "term": "v1_deactivateCashgram_body", "description": "", "source": "schema", "type": "object" }, { "term": "inline_response_200_9", "description": "", "source": "schema", "type": "object" }, { "term": "inline_response_404_4", "description": "", "source": "schema", "type": "object" }, { "term": "inline_response_200_11", "description": "", "source": "schema", "type": "object" }, { "term": "inline_response_200_8_data", "description": "", "source": "schema", "type": "object" }, { "term": "referenceId", "description": "", "source": "property", "schema": "inline_response_200_8_data" }, { "term": "cashgramLink", "description": "", "source": "property", "schema": "inline_response_200_8_data" }, { "term": "inline_response_200_11_data", "description": "", "source": "schema", "type": "object" }, { "term": "cashgramStatus", "description": "", "source": "property", "schema": "inline_response_200_11_data" }, { "term": "PayoutFetchTransfer", "description": "Use this API to get the status of the initiated transfer. You can use either the transfer_id or cf_transfer_id to fetch the details.", "source": "operation" }, { "term": "PayoutInitiateTransfer", "description": "Use this API to initiate an amount transfer at Cashfree Payments. It is an async request by default.", "source": "operation" }, { "term": "PayoutFetchBatchTransfer", "description": "Use this API to get the status of the initiated batch transfer. You can use either the batch_transfer_id or cf_batch_transfer_id to fetch the details.", "source": "operation" }, { "term": "PayoutInitiateBatchTransfer", "description": "Use this API to initiate a batch transfer request at Cashfree Payments. You can transfer money to multiple beneficiaries. The batch transfer limit is 5,000 in the production environment and 1,000 by default in the test environment.", "source": "operation" }, { "term": "PayoutFetchBeneficiary", "description": "Use this API to get the details of a particular beneficiary from your account. You can pass either beneficiary_id or the combination of bank_account_number and bank_ifsc to fetch the details.", "source": "operation" }, { "term": "PayoutCreateBeneficiary", "description": "Use this API to add a beneficiary to your Cashfree Payments account by providing the bank account number, IFSC, and other required details. Ensure the successful creation of the benficiary in your account before initiating a transfer.", "source": "operation" }, { "term": "PayoutDeleteBeneficiary", "description": "Use this API to remove an existing beneficiary from the list of added beneficiaries.", "source": "operation" }, { "term": "authorize-2", "description": "Use this API to authenticate with the Cashfree system and obtain the authorization bearer token. All other API calls must have this token as Authorization header in the format 'Bearer <token>' (without quotes) for them to get processed. The generated token is valid for 6 minutes.", "source": "operation" }, { "term": "create-cashgram1", "description": "Use this API to create a Cashgram.", "source": "operation" }, { "term": "deactivate-cashgram1", "description": "Deactivate Cashgram", "source": "operation" }, { "term": "get-cashgram-status1", "description": "Use this API to get the status of the Cashgram created.", "source": "operation" }, { "term": "Aadhaar", "description": "Operations related to Aadhaar verification.", "source": "tag" }, { "term": "BAV V2", "description": "Operations related to Bank account verification v2.", "source": "tag" }, { "term": "PAN", "description": "Operations related to PAN verification.", "source": "tag" }, { "term": "Digilocker", "description": "Operations related to Digilocker verification.", "source": "tag" }, { "term": "E-sign", "description": "Operations related to E-sign verification.", "source": "tag" }, { "term": "Reverse Penny Drop", "description": "Operations related to Reverse Penny Drop verification.", "source": "tag" }, { "term": "IP", "description": "Operation related to IP verification.", "source": "tag" }, { "term": "UPI", "description": "Operations related to UPI verification.", "source": "tag" }, { "term": "Passport", "description": "Operation related to Passport verification.", "source": "tag" }, { "term": "CIN", "description": "Operation related to CIN verification.", "source": "tag" }, { "term": "Name Match", "description": "Operation related to Name Match verification.", "source": "tag" }, { "term": "PAN to GSTIN", "description": "Operation related to PAN to GSTIN.", "source": "tag" }, { "term": "Face Match", "description": "Operation related to Face Match verification.", "source": "tag" }, { "term": "Voter ID", "description": "Operation related to Voter ID verification.", "source": "tag" }, { "term": "Reverse Geocoding", "description": "Operation related to Reverse Geocoding.", "source": "tag" }, { "term": "Liveliness", "description": "Operation related to Liveliness.", "source": "tag" }, { "term": "Vehicle RC", "description": "Operation related to Vehicle RC verification.", "source": "tag" }, { "term": "Driving License", "description": "Operation related to Driving License verification.", "source": "tag" }, { "term": "GSTIN", "description": "Operation related to GSTIN verification.", "source": "tag" }, { "term": "Account Aggregator", "description": "Operations related to Account aggregator.", "source": "tag" }, { "term": "OTPLess", "description": "Operations related to OTPLess Verification.", "source": "tag" }, { "term": "Secure-Share", "description": "Operations related to secure-share.", "source": "tag" }, { "term": "BharatOCR", "description": "Operations related to BharatOCR.", "source": "tag" }, { "term": "BharatOCRRequestSchema", "description": "Request parameters for BharatOCR.", "source": "schema", "type": "object" }, { "term": "verification_id", "description": "It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.", "source": "property", "schema": "BharatOCRRequestSchema" }, { "term": "file_url", "description": "Public URL of the image. Allowed only https URL. Allowed file types: JPEG, JPG, or PNG. The maximum file size is 5 MB. Conditionally required when the image is missing.", "source": "property", "schema": "BharatOCRRequestSchema" }, { "term": "do_verification", "description": "Indicates whether PAN verification should be performed. When set to `true`, the API validates the individual's PAN details, including the unique identifier, name, date of birth, and other relevant information. This verification assists in customer onboarding, KYC compliance, and fraud prevention. Defaults to `false`.", "source": "property", "schema": "BharatOCRRequestSchema" }, { "term": "BharatOCRResponseSchema", "description": "Success response for retrieving the list of information associated with the mobile number.", "source": "schema", "type": "object" }, { "term": "reference_id", "description": "It displays the unique ID created by Cashfree Payments for reference purposes.", "source": "property", "schema": "BharatOCRResponseSchema" }, { "term": "document_fields", "description": "Structure with all the relevant fields in the input image.", "source": "property", "schema": "BharatOCRResponseSchema" }, { "term": "quality_checks", "description": "Contains all the quality checks the product performs on the given input image.", "source": "property", "schema": "BharatOCRResponseSchema" }, { "term": "fraud_checks", "description": "It displays the personal information of the mobile number holder.", "source": "property", "schema": "BharatOCRResponseSchema" }, { "term": "verification_details", "description": "It displays the personal information of the mobile number holder.", "source": "property", "schema": "BharatOCRResponseSchema" }, { "term": "Scope", "description": "", "source": "schema", "type": "object" }, { "term": "scope", "description": "This describes the scope for which the user has provided consent.", "source": "property", "schema": "Scope" }, { "term": "records", "description": "", "source": "property", "schema": "Scope" }, { "term": "GenerateKYCLinkRequestSchema", "description": "Request Body Schema for Generate KYC Link", "source": "schema", "type": "object" }, { "term": "template_name", "description": "It is the name of the template you created using the merchant dashboard. You can also use the default template found there to generate the verification form. The default template is Aadhaar_verification. Using merchant dashboard, customized KYC Link templates can be created.", "source": "property", "schema": "GenerateKYCLinkRequestSchema" }, { "term": "link_expiry", "description": "It is the expiry date of the link. Its value can be max 30 days from the current date.", "source": "property", "schema": "GenerateKYCLinkRequestSchema" }, { "term": "notification_types", "description": "It is the type(s) of notification used for sending the link.", "source": "property", "schema": "GenerateKYCLinkRequestSchema" }, { "term": "GenerateFormLinkResponseSchema", "description": "Find the success response of Generate KYC Link", "source": "schema", "type": "object" }, { "term": "form_link", "description": "It displays the URL of the KYC Link.", "source": "property", "schema": "GenerateFormLinkResponseSchema" }, { "term": "form_status", "description": "It displays the status of the form.", "source": "property", "schema": "GenerateFormLinkResponseSchema" }, { "term": "StaticKYCLinkRequestSchema", "description": "Request Body Schema for Generate Static KYC Link", "source": "schema", "type": "object" }, { "term": "GenerateFormLinkQRCodeResponseSchema", "description": "Find the success response of Generate Static KYC Link", "source": "schema", "type": "object" }, { "term": "static_link", "description": "It displays the URL of the static KYC Link.", "source": "property", "schema": "GenerateFormLinkQRCodeResponseSchema" }, { "term": "qr_code", "description": "It displays the generated QR code link to the static KYC Link. request.", "source": "property", "schema": "GenerateFormLinkQRCodeResponseSchema" }, { "term": "DeactivateStaticKYCLinkResponseSchema", "description": "Find the success response of Deactivate Static KYC Link", "source": "schema", "type": "object" }, { "term": "getFormStatusResponseSchema", "description": "Find the success response for Get Form Status", "source": "schema", "type": "object" }, { "term": "aadhaarFormStatusResponseSchema", "description": "It displays the status of aadhaar verification", "source": "schema", "type": "object" }, { "term": "aadhaarFormDetailResponseSchema", "description": "Offline Aadhaar Verification Details", "source": "schema", "type": "object" }, { "term": "care-of", "description": "", "source": "property", "schema": "aadhaarFormDetailResponseSchema" }, { "term": "address", "description": "", "source": "property", "schema": "aadhaarFormDetailResponseSchema" }, { "term": "dob", "description": "", "source": "property", "schema": "aadhaarFormDetailResponseSchema" }, { "term": "gender", "description": "", "source": "property", "schema": "aadhaarFormDetailResponseSchema" }, { "term": "photo_link", "description": "", "source": "property", "schema": "aadhaarFormDetailResponseSchema" }, { "term": "mobile_hash", "description": "", "source": "property", "schema": "aadhaarFormDetailResponseSchema" }, { "term": "split_address", "description": "", "source": "property", "schema": "aadhaarFormDetailResponseSchema" }, { "term": "panFormStatusResponseSchema", "description": "PAN Verification Product Status", "source": "schema", "type": "object" }, { "term": "panFormDetailResponseSchema", "description": "PAN Verification Details Response", "source": "schema", "type": "object" }, { "term": "name_provided", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "registered_name", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "valid", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "name_match_score", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "name_match_result", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "aadhaar_seeding_status", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "last_updated_at", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "name_pan_card", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "pan_status", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "aadhaar_seeding_status_desc", "description": "", "source": "property", "schema": "panFormDetailResponseSchema" }, { "term": "bavFormStatusResponseSchema", "description": "Bank Details Validation Product Status", "source": "schema", "type": "object" }, { "term": "bavFormDetailSchema", "description": "Bank Details Validation Details", "source": "schema", "type": "object" }, { "term": "accountStatus", "description": "", "source": "property", "schema": "bavFormDetailSchema" }, { "term": "accountStatusCode", "description": "", "source": "property", "schema": "bavFormDetailSchema" }, { "term": "bavDataSchema", "description": "Bank Details Response", "source": "schema", "type": "object" }, { "term": "nameAtBank", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "bankName", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "branch", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "utr", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "micr", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "nameMatchScore", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "nameMatchResult", "description": "", "source": "property", "schema": "bavDataSchema" }, { "term": "upiFormStatusResponseSchema", "description": "Upi Verification Product Status", "source": "schema", "type": "object" }, { "term": "upiFormDetailResponseSchema", "description": "UPI Verification Details Response", "source": "schema", "type": "object" }, { "term": "accountExists", "description": "", "source": "property", "schema": "upiFormDetailResponseSchema" }, { "term": "split_address_schema", "description": "Split address for Split addresss in Offline Aadhaar verify OTP Response.", "source": "schema", "type": "object" }, { "term": "dist", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "house", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "landmark", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "po", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "street", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "subdist", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "vtc", "description": "", "source": "property", "schema": "split_address_schema" }, { "term": "smsString", "description": "SMS string", "source": "schema", "type": "string" }, { "term": "emailString", "description": "Email string", "source": "schema", "type": "string" }, { "term": "whatsappString", "description": "Whatsapp string", "source": "schema", "type": "string" }, { "term": "Mobile_Record", "description": "It displays the mobile number linked to the user.", "source": "schema", "type": "object" }, { "term": "confidence_score", "description": "Indicates the system's certainty about the accuracy of the mobile number details extracted or matched.", "source": "property", "schema": "Mobile_Record" }, { "term": "Email_Record", "description": "It displays the email address associated with the user.", "source": "schema", "type": "object" }, { "term": "Address_Record", "description": "It displays the complete address details of the user.", "source": "schema", "type": "object" }, { "term": "Gender_Record", "description": "It displays the user's gender.", "source": "schema", "type": "object" }, { "term": "DOB_Record", "description": "It displays the user's date of birth.", "source": "schema", "type": "object" }, { "term": "Aadhaar_Record", "description": "It displays the details linked to the user's Aadhaar card.", "source": "schema", "type": "object" }, { "term": "SplitAddressRecord", "description": "A detailed breakdown of the address information.", "source": "schema", "type": "object" }, { "term": "PAN_Record", "description": "It displays information of the user's PAN (Permanent Account Number) card.", "source": "schema", "type": "object" }, { "term": "BAV_Record", "description": "It displays the user's bank account information.", "source": "schema", "type": "object" }, { "term": "Name_Record", "description": "It displays the user's full name.", "source": "schema", "type": "object" }, { "term": "Occupation_Record", "description": "It displays the user's occupation information.", "source": "schema", "type": "object" }, { "term": "Income_Record", "description": "It displays the user's income range.", "source": "schema", "type": "object" }, { "term": "UVDataAvailabilityRequestSchema", "description": "Request for data availability of the user.", "source": "schema", "type": "object" }, { "term": "user", "description": "It displays the list of user identifiers.", "source": "property", "schema": "UVDataAvailabilityRequestSchema" }, { "term": "UVDataAvailabilityResponseSchema", "description": "Response for user data availability.", "source": "schema", "type": "object" }, { "term": "available_scopes", "description": "It displays the list of available scopes.\nPossible values are:\n`AADHAAR` `PAN` `DOB` `EMAIL` `GENDER` `MOBILE` `NAME` `OCCUPATION` `ADDRESS`", "source": "property", "schema": "UVDataAvailabilityResponseSchema" }, { "term": "AadhaarMaskingResponseSchema", "description": "Success response for Aadhaar Masking API", "source": "schema", "type": "object" }, { "term": "image_link", "description": "It displays the URL of the image.", "source": "property", "schema": "AadhaarMaskingResponseSchema" }, { "term": "AadhaarOcrRequestSchema", "description": "Request body schema for Aadhaar Verification via OCR.", "source": "schema", "type": "object" }, { "term": "back_image", "description": "It is the scanned image of the back of the aadhaar card. Allowed file type - JPEG/JPG/PNG. The max file size of both the files is 10MB.", "source": "property", "schema": "AadhaarOcrRequestSchema" }, { "term": "front_image", "description": "It is the scanned image of the front of the aadhaar card. Allowed file type - JPEG/JPG/PNG. The max file size of both the files is 10MB.", "source": "property", "schema": "AadhaarOcrRequestSchema" }, { "term": "AadhaarOcrResponseSchema", "description": "Success response for Aadhaar Verification via OCR", "source": "schema", "type": "object" }, { "term": "yob", "description": "It displays the year of birth of the aadhaar card holder.", "source": "property", "schema": "AadhaarOcrResponseSchema" }, { "term": "father", "description": "It displays the father's name of the aadhaar card holder.", "source": "property", "schema": "AadhaarOcrResponseSchema" }, { "term": "uid", "description": "It displays the UID information as present in the aadhaar card.", "source": "property", "schema": "AadhaarOcrResponseSchema" }, { "term": "complete_address", "description": "It displays the complete address information of the individual.", "source": "property", "schema": "AddressDetails" }, { "term": "AddressDetailsMobile360", "description": "It contains the address information of the individual.", "source": "schema", "type": "object" }, { "term": "AdvanceEmploymentRequestSchema", "description": "Find the request parameters to retrieve employment infomration", "source": "schema", "type": "object" }, { "term": "uan", "description": "It is the unique number assigned to every employee contributing to the Employees' Provident Fund (EPF). **(conditonal mandatory)**", "source": "property", "schema": "AdvanceEmploymentRequestSchema" }, { "term": "employee_name", "description": "It is the name of the employee. **(conditonal mandatory)**", "source": "property", "schema": "AdvanceEmploymentRequestSchema" }, { "term": "employer_name", "description": "It is the name of the employer. **(conditonal mandatory)**", "source": "property", "schema": "AdvanceEmploymentRequestSchema" }, { "term": "AdvanceEmploymentResponse", "description": "Success response for Get Employment Details", "source": "schema", "type": "object" }, { "term": "input", "description": "It contains the information entered in the API request.", "source": "property", "schema": "AdvanceEmploymentResponse" }, { "term": "uan_details", "description": "It contains the list of UAN details.", "source": "property", "schema": "AdvanceEmploymentResponse" }, { "term": "recent_employment_details", "description": "It contains the recent employment details of the individual.", "source": "property", "schema": "AdvanceEmploymentResponse" }, { "term": "BAVAsyncV2ResponseSchema", "description": "Find the response parameter for Bank Account Verification Async V2", "source": "schema", "type": "object" }, { "term": "user_id", "description": "It displays the user ID created by Cashfree Payments for reference purposes.", "source": "property", "schema": "BAVAsyncV2ResponseSchema" }, { "term": "account_status", "description": "It displays the status of the bank account.\nPossible values are:\n- `RECEIVED`\n\n[Click here to view the detailed descriptions of each value](https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bav-response-description#account-status-description).", "source": "property", "schema": "BAVAsyncV2ResponseSchema" }, { "term": "account_status_code", "description": "It displays the status code of the bank account.\nPossible values are:\n- `VALIDATION_IN_PROGRESS`\n\n[Click here to view the detailed descriptions of each value](https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bav-response-description#account-status-code-description).", "source": "property", "schema": "BAVAsyncV2ResponseSchema" }, { "term": "BulkBAVV2ResponseSchema", "description": "Find the response parameters for Bulk Bank Account Verification V2", "source": "schema", "type": "object" }, { "term": "bulk_reference_id", "description": "It displays the unique ID created by Cashfree Payments for reference purposes.\nformat: `int64`", "source": "property", "schema": "BulkBAVV2ResponseSchema" }, { "term": "bulk_verification_id", "description": "It displays the unique ID you created to identify the Bulk Bank Account Verification API request.", "source": "property", "schema": "BulkBAVV2ResponseSchema" }, { "term": "BAVV2ValidationSuccessfulSchema", "description": "Find the description for each response parameter", "source": "schema", "type": "object" }, { "term": "name_at_bank", "description": "It displays the name of the account holder as per the bank records.", "source": "property", "schema": "BAVV2ValidationSuccessfulSchema" }, { "term": "BAVV2GETValidationSuccessfulSchema", "description": "Find the description for each response parameter", "source": "schema", "type": "object" }, { "term": "BulkBAVV2ValidationSuccessfulSchema", "description": "Find the description for each response parameter", "source": "schema", "type": "object" }, { "term": "entries", "description": "It displays the verified bank account information", "source": "property", "schema": "BulkBAVV2ValidationSuccessfulSchema" }, { "term": "BadgeDetails", "description": "It contains information regarding any badges or emblems affixed to the vehicle. These badges could indicate various things such as the vehicle's model, trim level, special editions, or manufacturer-specific badges.", "source": "schema", "type": "object" }, { "term": "badge_issue_date", "description": "It displays the date of the badge issued.", "source": "property", "schema": "BadgeDetails" }, { "term": "badge_no", "description": "It displays the number of the badge issued.", "source": "property", "schema": "BadgeDetails" }, { "term": "class_of_vehicle", "description": "It displays the class of the vehicle.", "source": "property", "schema": "BadgeDetails" }, { "term": "BankAccountVerificationAsyncRequestSchema", "description": "Request Body for Async Bank account verification", "source": "schema", "type": "object" }, { "term": "bank_account", "description": "It is the bank account number for verification. It can be an alphanumeric value between 6 and 40 characters.", "source": "property", "schema": "BankAccountVerificationAsyncRequestSchema" }, { "term": "BankAccountVerificationBulkRequestSchema", "description": "Request Body for Bulk Bank account verification", "source": "schema", "type": "object" }, { "term": "BankAccountVerificationSyncRequestSchema", "description": "Request body for BAV V2 Sync", "source": "schema", "type": "object" }, { "term": "BulkPanRequestSchema", "description": "Find the request parameters to verify a large number of PAN information", "source": "schema", "type": "object" }, { "term": "CinRequestSchema", "description": "Find the request parameters to retrieve CIN information", "source": "schema", "type": "object" }, { "term": "CinResponseSchema", "description": "Success response for retrieving CIN information", "source": "schema", "type": "object" }, { "term": "company_name", "description": "It displays the name of the company registered under the Ministry of Corporate Affaris.", "source": "property", "schema": "CinResponseSchema" }, { "term": "registration_number", "description": "It displays the registration number of the company.", "source": "property", "schema": "CinResponseSchema" }, { "term": "incorporation_date", "description": "It displays the date of incorporation of the company.", "source": "property", "schema": "CinResponseSchema" }, { "term": "cin_status", "description": "It displays the granular level status of the CIN information.", "source": "property", "schema": "CinResponseSchema" }, { "term": "incorporation_country", "description": "It displays the name of the country where the company is located.", "source": "property", "schema": "CinResponseSchema" }, { "term": "director_details", "description": "", "source": "property", "schema": "CinResponseSchema" }, { "term": "CreateRequestRequestSchema", "description": "Find the request parameters to create a reverse penny order request", "source": "schema", "type": "object" }, { "term": "CreateRequestResponseSchema", "description": "Success response for creating a reverse penny order request", "source": "schema", "type": "object" }, { "term": "ref_id", "description": "It displays the unique ID created by Cashfree Payments for reference purposes.\nformat: `int64`", "source": "property", "schema": "CreateRequestResponseSchema" }, { "term": "valid_upto", "description": "It displays the time validity of the intent links in the create RPD request. By default, its value is 10 minutes from the time of link generation.", "source": "property", "schema": "CreateRequestResponseSchema" }, { "term": "upi_link", "description": "It displays the generated UPI link for the reverse penny drop request.", "source": "property", "schema": "CreateRequestResponseSchema" }, { "term": "paytm", "description": "It displays the generated Paytm link for the reverse drop request.", "source": "property", "schema": "CreateRequestResponseSchema" }, { "term": "bhim", "description": "It displays the generated BHIM link for the reverse penny drop request.", "source": "property", "schema": "CreateRequestResponseSchema" }, { "term": "gpay", "description": "It displays the generated Gpay link for the reverse penny drop request.", "source": "property", "schema": "CreateRequestResponseSchema" }, { "term": "phonepe", "description": "It displays the generated Phonepe link for the reverse penny drop request.", "source": "property", "schema": "CreateRequestResponseSchema" }, { "term": "DigiLockerVerifyAccountRequestSchema", "description": "Find the request parameters to verify a Digilocker account.", "source": "schema", "type": "object" }, { "term": "mobile_number", "description": "It is the mobile number of a user. Either an Aadhaar number or mobile is required to verify whether a Digilocker account exists. **(conditonal mandatory)**", "source": "property", "schema": "DigiLockerVerifyAccountRequestSchema" }, { "term": "aadhaar_number", "description": "It is the unique 12-digit identification number issued by the Unique Identification Authority of India (UIDAI). Either an Aadhaar number or mobile is required to verify whether a Digilocker account exists. **(conditonal mandatory)**", "source": "property", "schema": "DigiLockerVerifyAccountRequestSchema" }, { "term": "DigiLockerVerificationCreateUrlRequestSchema", "description": "Find the request parameters to create a DigiLocker URL for the document verification.", "source": "schema", "type": "object" }, { "term": "document_requested", "description": "It is the list of customer documents required for verification.", "source": "property", "schema": "DigiLockerVerificationCreateUrlRequestSchema" }, { "term": "redirect_url", "description": "It is the URL you need to provide to redirect the user after completing the DigiLocker journey. It will contain the verification_id, which can be used to check the status of the verification.", "source": "property", "schema": "DigiLockerVerificationCreateUrlRequestSchema" }, { "term": "DigiLockerVerifyAccountResponseSchema", "description": "Response of verify DigiLocker account API.", "source": "schema", "type": "object" }, { "term": "digilocker_id", "description": "It is a unique 36-character DigiLocker ID of the user account.", "source": "property", "schema": "DigiLockerVerifyAccountResponseSchema" }, { "term": "DigiLockerVerificationCreateUrlResponseSchema", "description": "Success response for creating a DigiLocker URL for document verification.", "source": "schema", "type": "object" }, { "term": "DigiLockerVerificationGetAadhaarDocumentResponseSchema", "description": "Success response for Get Aadhaar DigiLocker Document API", "source": "schema", "type": "object" }, { "term": "care_of", "description": "It displays the name of the parent or guardian.", "source": "property", "schema": "DigiLockerVerificationGetAadhaarDocumentResponseSchema" }, { "term": "xml_file", "description": "It is the link which points to the zip file containing the XML file and has 48 hrs expiry", "source": "property", "schema": "DigiLockerVerificationGetAadhaarDocumentResponseSchema" }, { "term": "DigiLockerVerificationGetPanDocumentResponseSchema", "description": "Success response for Get Pan DigiLocker Document API", "source": "schema", "type": "object" }, { "term": "DigiLockerVerificationGetDLDocumentResponseSchema", "description": "Success response for Get Driving License Digilocker Document API", "source": "schema", "type": "object" }, { "term": "dl_number", "description": "It is the driving licence number of the individual.", "source": "property", "schema": "DigiLockerVerificationGetDLDocumentResponseSchema" }, { "term": "issued_at", "description": "It displays the place where a driving license is issued.", "source": "property", "schema": "DigiLockerVerificationGetDLDocumentResponseSchema" }, { "term": "issue_date", "description": "It displays the issue date of driving license.", "source": "property", "schema": "DigiLockerVerificationGetDLDocumentResponseSchema" }, { "term": "categories", "description": "", "source": "property", "schema": "DigiLockerVerificationGetDLDocumentResponseSchema" }, { "term": "expiry_date", "description": "It displays the date until which the driving license is valid.", "source": "property", "schema": "DigiLockerVerificationGetDLDocumentResponseSchema" }, { "term": "present_address", "description": "It displays the current address of the owner of the vehicle.", "source": "property", "schema": "DigiLockerVerificationGetDLDocumentResponseSchema" }, { "term": "permanent_address", "description": "It displays the permanent address of the owner of the vehicle.", "source": "property", "schema": "DigiLockerVerificationGetDLDocumentResponseSchema" }, { "term": "DigiLockerVerificationGetStatusResponseSchema", "description": "Success response of Get DigiLocker Verification Status", "source": "schema", "type": "object" }, { "term": "user_details", "description": "It displays the details of the individual(user).", "source": "property", "schema": "DigiLockerVerificationGetStatusResponseSchema" }, { "term": "document_consent", "description": "It displays the consent of the individual(user) for document verification.", "source": "property", "schema": "DigiLockerVerificationGetStatusResponseSchema" }, { "term": "DrivingLicenceDetails", "description": "It contains the details of the driving licence.", "source": "schema", "type": "object" }, { "term": "date_of_issue", "description": "", "source": "property", "schema": "DrivingLicenceDetails" }, { "term": "date_of_last_transaction", "description": "", "source": "property", "schema": "DrivingLicenceDetails" }, { "term": "last_transacted_at", "description": "", "source": "property", "schema": "DrivingLicenceDetails" }, { "term": "father_or_husband_name", "description": "", "source": "property", "schema": "DrivingLicenceDetails" }, { "term": "address_list", "description": "", "source": "property", "schema": "DrivingLicenceDetails" }, { "term": "photo", "description": "", "source": "property", "schema": "DrivingLicenceDetails" }, { "term": "cov_details", "description": "", "source": "property", "schema": "DrivingLicenceDetails" }, { "term": "DrivingLicenseRequestSchema", "description": "Find the request parameters to retrieve driving licence information", "source": "schema", "type": "object" }, { "term": "DrivingLicenseResponseSchema", "description": "Success response for retrieving driving licence information", "source": "schema", "type": "object" }, { "term": "badge_details", "description": "It contains the...", "source": "property", "schema": "DrivingLicenseResponseSchema" }, { "term": "dl_validity", "description": "It contains the different information regarding the validity of the licence.", "source": "property", "schema": "DrivingLicenseResponseSchema" }, { "term": "details_of_driving_licence", "description": "", "source": "property", "schema": "DrivingLicenseResponseSchema" }, { "term": "ESignVerificationCreateSignatureRequestSchema", "description": "Find the request parameters to add the details of the document and signer(s)", "source": "schema", "type": "object" }, { "term": "notification_modes", "description": "It is how you want to notify the signee about the e-sign details.", "source": "property", "schema": "ESignVerificationCreateSignatureRequestSchema" }, { "term": "auth_type", "description": "It is the type of authentication to be used for signature.", "source": "property", "schema": "ESignVerificationCreateSignatureRequestSchema" }, { "term": "expiry_in_days", "description": "It is the expiry of the signing link for each signer in days. The maximum allowed time is 15 days.", "source": "property", "schema": "ESignVerificationCreateSignatureRequestSchema" }, { "term": "signers", "description": "It should contain the details of the signer(s).", "source": "property", "schema": "ESignVerificationCreateSignatureRequestSchema" }, { "term": "ESignVerificationCreateSignatureResponseSchema", "description": "Success response for Create E-Sign RequestR", "source": "schema", "type": "object" }, { "term": "signing_link", "description": "It displays the link to proceed with the e-signature of the document for the first signer.", "source": "property", "schema": "ESignVerificationCreateSignatureResponseSchema" }, { "term": "ESignVerificationGetStatusResponseSchema", "description": "Success response for Get E-Sign Status", "source": "schema", "type": "object" }, { "term": "signed_doc_url", "description": "It displays the link of the signed document.", "source": "property", "schema": "ESignVerificationGetStatusResponseSchema" }, { "term": "ESignVerificationUploadDocumentRequestSchema", "description": "Find the request parameters to upload the document that requires an e-signature.", "source": "schema", "type": "object" }, { "term": "document", "description": "Upload the document that requires an e-sign. Allowed file type - PDF. Max file size allowed - 10MB.", "source": "property", "schema": "ESignVerificationUploadDocumentRequestSchema" }, { "term": "ESignVerificationUploadDocumentResponseSchema", "description": "Success response for Upload Document For E-Sign", "source": "schema", "type": "object" }, { "term": "EmailDetailsMobile360", "description": "It contains all the email information of the individual.", "source": "schema", "type": "object" }, { "term": "sequence", "description": "It displays sequence of the list.", "source": "property", "schema": "EmailDetailsMobile360" }, { "term": "ErrorResponseSchema", "description": "Response in case of error.", "source": "schema", "type": "object" }, { "term": "error", "description": "", "source": "property", "schema": "ErrorResponseSchema" }, { "term": "FaceMatchRequestSchema", "description": "Find the request parameters to verify facial features in two images.", "source": "schema", "type": "object" }, { "term": "first_image", "description": "It is the scanned copy of the image 1. Allowed file type - JPEG/JPG/PNG. Maximum file size allowed for both the files is 5 MB.", "source": "property", "schema": "FaceMatchRequestSchema" }, { "term": "second_image", "description": "It is the scanned copy of the image 2. Allowed file types are JPEG/JPG/PNG. Maximum file size allowed for both the files is 5 MB.", "source": "property", "schema": "FaceMatchRequestSchema" }, { "term": "threshold", "description": "It is the value to distinguish and match the facial features of the two images. The range is between 0 and 1. The default value is set as 0.75. We conclude that the images match when the analysis is or greater than the value set for threshold.", "source": "property", "schema": "FaceMatchRequestSchema" }, { "term": "FaceMatchResponseSchema", "description": "Success response for Face Match API", "source": "schema", "type": "object" }, { "term": "face_match_result", "description": "It displays the result of the face match verification request.\nPossible values are:\n- `YES`: The face match is positive i.e. the given 2 photos match.\n- `NO`: The face match is negative i.e. the given 2 photos don't match.", "source": "property", "schema": "FaceMatchResponseSchema" }, { "term": "face_match_score", "description": "It displays the score of the face match verification request.\nRange: `0 < x < 1`", "source": "property", "schema": "FaceMatchResponseSchema" }, { "term": "GetPanBulkResponseSchema", "description": "Response for Verify Bulk PAN API", "source": "schema", "type": "object" }, { "term": "count", "description": "", "source": "property", "schema": "GetPanBulkResponseSchema" }, { "term": "GetStatusRpdResponseSchema", "description": "Reverse penny drop verification successful", "source": "schema", "type": "object" }, { "term": "processed_on", "description": "It displays the date and time of when the request was processed.", "source": "property", "schema": "GetStatusRpdResponseSchema" }, { "term": "penny_collected_on", "description": "It displays the date and time of when the 1 rupee was collected.", "source": "property", "schema": "GetStatusRpdResponseSchema" }, { "term": "reversal_status", "description": "It displays the status of the rupee reversal.\nPossible values are:\n- `TRANSFER_INITIATED`: Reversal is initiated.\n- `TRANSFER_SUCCESS`: The reversal process is successful.\n- `PENDING`: The reversal is pending and not initiated yet.\n- `FAILED`: The reversal is failed.", "source": "property", "schema": "GetStatusRpdResponseSchema" }, { "term": "GetVerifyPanResponseSchema", "description": "Success response for Verify PAN Sync API", "source": "schema", "type": "object" }, { "term": "father_name", "description": "It displays the father's name of the PAN card holder.", "source": "property", "schema": "GetVerifyPanResponseSchema" }, { "term": "GstinRequestSchema", "description": "Find the request parameters to verify GSTIN information", "source": "schema", "type": "object" }, { "term": "business_name", "description": "It is the name of the business to which the GSTIN is issued. The maximum character limit is 200.", "source": "property", "schema": "GstinRequestSchema" }, { "term": "GstinResponseSchema", "description": "Response for Verify GSTIN, which includes the GSTIN details, business information, and address details.", "source": "schema", "type": "object" }, { "term": "legal_name_of_business", "description": "Legal name of the business registered under the GST system.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "trade_name_of_business", "description": "Trade name of the business registered under the GST system.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "center_jurisdiction", "description": "Center jurisdiction under which the business falls.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "state_jurisdiction", "description": "State jurisdiction under which the business falls.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "date_of_registration", "description": "Date of GST registration for the business.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "constitution_of_business", "description": "Constitution type of the business, such as Private Limited, Proprietorship, etc.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "taxpayer_type", "description": "Taxpayer type, indicating whether the business is a Regular taxpayer, Composition taxpayer, etc.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "gst_in_status", "description": "Current status of the GSTIN.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "last_update_date", "description": "Date when the GST details were last updated.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "nature_of_business_activities", "description": "List of activities performed by the business, such as Retail Business, Supplier of Services, etc.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "principal_place_address", "description": "Complete principal place address of the business.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "principal_place_split_address", "description": "Split components of the principal place address.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "additional_address_array", "description": "List of additional addresses associated with the business.", "source": "property", "schema": "GstinResponseSchema" }, { "term": "IdentityDetailsMobile360", "description": "It displays all the identity number linked for individual", "source": "schema", "type": "object" }, { "term": "number", "description": "It displays the identity number of the individual.", "source": "property", "schema": "IdentityDetailsMobile360" }, { "term": "IpVerificationRequestSchema", "description": "Find the request parameters to verify IP address", "source": "schema", "type": "object" }, { "term": "ip_address", "description": "It is the IP address that you need to verify which is assigned to a device connected to a computer network.", "source": "property", "schema": "IpVerificationRequestSchema" }, { "term": "IpVerificationResponseSchema", "description": "Verify IP success response", "source": "schema", "type": "object" }, { "term": "proxy_type", "description": "It displays the category or classification of a proxy server based on its functionality and how it handles network requests.", "source": "property", "schema": "IpVerificationResponseSchema" }, { "term": "country_name", "description": "It displays the name of the country associated with the geographical location of the device or network to which the IP address is assigned.", "source": "property", "schema": "IpVerificationResponseSchema" }, { "term": "region_name", "description": "It displays the name of the region associated with the geographical location of the device or network to which the IP address is assigned.", "source": "property", "schema": "IpVerificationResponseSchema" }, { "term": "city_name", "description": "It displays the name of the city associated with the geographical location of the device or network to which the IP address is assigned.", "source": "property", "schema": "IpVerificationResponseSchema" }, { "term": "city_risk_score", "description": "It displays the risk score associated with a particular city based on factors such as cybersecurity threats, crime rates, or other relevant data.", "source": "property", "schema": "IpVerificationResponseSchema" }, { "term": "proxy_type_risk_score", "description": "It displays the risk score associated with a particular city based on factors such as cybersecurity threats, crime rates, or other relevant data.", "source": "property", "schema": "IpVerificationResponseSchema" }, { "term": "LivelinessRequestSchema", "description": "Find the request parameters to check the liveliness in an image", "source": "schema", "type": "object" }, { "term": "image", "description": "Upload the image of the individual to verify the liveliness of the image.", "source": "property", "schema": "LivelinessRequestSchema" }, { "term": "strict_check", "description": "It is the boolean value to set the strictness check of the image. Default value for strict_check is false.", "source": "property", "schema": "LivelinessRequestSchema" }, { "term": "Liveliness200ResponseSchema", "description": "Success response for Liveliness Check API", "source": "schema", "type": "object" }, { "term": "liveliness", "description": "It displays the result of the liveliness check.", "source": "property", "schema": "Liveliness200ResponseSchema" }, { "term": "score", "description": "It displays the score of the liveliness check. \nRange: `0 < x < 1`", "source": "property", "schema": "Liveliness200ResponseSchema" }, { "term": "Mobile360RequestSchema", "description": "Find the request parameters for Mobile 360", "source": "schema", "type": "object" }, { "term": "consent_desc", "description": "It is the description that explains fetching the data.", "source": "property", "schema": "Mobile360RequestSchema" }, { "term": "Mobile360SendOtpRequestSchema", "description": "", "source": "schema", "type": "object" }, { "term": "user_consent", "description": "", "source": "property", "schema": "Mobile360SendOtpRequestSchema" }, { "term": "Mobile360ConsentSchema", "description": "Consent details for Mobile360 Send OTP", "source": "schema", "type": "object" }, { "term": "obtained", "description": "Indicates whether the user has given consent.", "source": "property", "schema": "Mobile360ConsentSchema" }, { "term": "timestamp", "description": "Timestamp when the consent was provided. The value must be in UTC and must be within 5 minutes before or after the current time.", "source": "property", "schema": "Mobile360ConsentSchema" }, { "term": "purpose", "description": "The description of the consent. The length must be between 20 and 100 characters. Allowed characters are alphanumeric, period (.), hyphen (-), slash (/), ampersand (&), and underscore (_).", "source": "property", "schema": "Mobile360ConsentSchema" }, { "term": "network_details", "description": "", "source": "property", "schema": "Mobile360ConsentSchema" }, { "term": "device_details", "description": "", "source": "property", "schema": "Mobile360ConsentSchema" }, { "term": "Mobile360VerifyOtpRequestSchema", "description": "", "source": "schema", "type": "object" }, { "term": "Mobile360ResponseSchema", "description": "Success response", "source": "schema", "type": "object" }, { "term": "ifsc_details", "description": "It displays the details corresponding to IFSC.", "source": "property", "schema": "Mobile360ResponseSchema" }, { "term": "Mobile360VerifyOtpResponseSchema", "description": "", "source": "schema", "type": "object" }, { "term": "personal_details", "description": "Personal information of the individual.", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "phone_numbers", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "emails", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "passport_details", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "bank_account_details", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "aadhaar_details", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "ration_card_details", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "driving_license_details", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "voter_details", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "pan_details", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "addresses", "description": "", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "employment_details", "description": "Employment details of the individual.", "source": "property", "schema": "Mobile360VerifyOtpResponseSchema" }, { "term": "Mobile360SendOtpResponseSchema", "description": "", "source": "schema", "type": "object" }, { "term": "NameMatchRequestSchema", "description": "Find the request parameters for the Name Match API", "source": "schema", "type": "object" }, { "term": "name_1", "description": "It is the name you want to verify.", "source": "property", "schema": "NameMatchRequestSchema" }, { "term": "name_2", "description": "It is the name you want to verify with name_1.", "source": "property", "schema": "NameMatchRequestSchema" }, { "term": "NameMatchResponseSchema", "description": "Success response for Name Match API", "source": "schema", "type": "object" }, { "term": "OfflineAadhaarSendOtpRequestSchema", "description": "Find the request parameters to generate an OTP for aadhaar verification", "source": "schema", "type": "object" }, { "term": "OfflineAadhaarSendOtpResponseSchema", "description": "Success response for Generate OTP to Verify Aadhaar API", "source": "schema", "type": "object" }, { "term": "OfflineAadhaarVerifyOtpRequestSchema", "description": "Find the request parameters to submit the OTP for aadhaar verification", "source": "schema", "type": "object" }, { "term": "OfflineAadhaarVerifyOtpResponseSchema", "description": "Success response for Submit OTP for Aadhaar Verification", "source": "schema", "type": "object" }, { "term": "year_of_birth", "description": "It displays the year of birth of the aadhaar card holder.", "source": "property", "schema": "OfflineAadhaarVerifyOtpResponseSchema" }, { "term": "share_code", "description": "It is the passcode with which we can unzip the xml file", "source": "property", "schema": "OfflineAadhaarVerifyOtpResponseSchema" }, { "term": "PanAdvanceRequestSchema", "description": "Find the request parameters to verify PAN information", "source": "schema", "type": "object" }, { "term": "PanAdvanceResponseSchema", "description": "Success response for PAN Advance", "source": "schema", "type": "object" }, { "term": "first_name", "description": "It displays the first name as present in the PAN information.", "source": "property", "schema": "PanAdvanceResponseSchema" }, { "term": "last_name", "description": "It displays the last name as present in the PAN information.", "source": "property", "schema": "PanAdvanceResponseSchema" }, { "term": "date_of_birth", "description": "It displays the date of birth of the individual.", "source": "property", "schema": "PanAdvanceResponseSchema" }, { "term": "masked_aadhaar_number", "description": "It displays the masked aadhaar number of the individual.", "source": "property", "schema": "PanAdvanceResponseSchema" }, { "term": "aadhaar_linked", "description": "It displays the aadhaar and PAN link status.", "source": "property", "schema": "PanAdvanceResponseSchema" }, { "term": "PanLiteRequestSchema", "description": "Find the request parameters for PAN Lite", "source": "schema", "type": "object" }, { "term": "PanLiteResponseSchema", "description": "Success response for verifying PAN information", "source": "schema", "type": "object" }, { "term": "name_match", "description": "It displays the result of name match verification.\nThe possible values are:\n\n - `Y` : The name entered matches with the name present on the PAN.\n\n - `N` : The name entered does matches with the name present on the PAN.", "source": "property", "schema": "PanLiteResponseSchema" }, { "term": "dob_match", "description": "It displays the result of the date of birth verification. \nThe possible values are:\n\n - `Y` : The date of birth of the individual matches with the date of birth present on PAN.\n\n - `N` : The date of birth of the individual does not matches with the date of birth present on PAN.", "source": "property", "schema": "PanLiteResponseSchema" }, { "term": "PanOcrRequestSchema", "description": "Find the request parameters to verify PAN via OCR", "source": "schema", "type": "object" }, { "term": "PanOcrResponseSchema", "description": "PAN Verification via OCR success response", "source": "schema", "type": "object" }, { "term": "organization_name", "description": "It displays the name of the organisation the individual runs.", "source": "property", "schema": "PanOcrResponseSchema" }, { "term": "pan_type", "description": "It displays the type of PAN issued to the individual.", "source": "property", "schema": "PanOcrResponseSchema" }, { "term": "date_of_incorporation", "description": "It displays the incorporation date of the individual's organisation.", "source": "property", "schema": "PanOcrResponseSchema" }, { "term": "age", "description": "It displays the age of the individual.", "source": "property", "schema": "PanOcrResponseSchema" }, { "term": "PanRequestSchema", "description": "Find the request parameters to verify PAN", "source": "schema", "type": "object" }, { "term": "PanToGstinRequestSchema", "description": "Find the request parameters to fetch the list of GSTIN associated with PAN", "source": "schema", "type": "object" }, { "term": "PanToGstinResponseSchema", "description": "Success response for Fetch GSTIN with PAN", "source": "schema", "type": "object" }, { "term": "gstin_list", "description": "It displays the list of GSTIN associated with the entered PAN.", "source": "property", "schema": "PanToGstinResponseSchema" }, { "term": "PassportVerificationRequestSchema", "description": "Find the request parameters to verify passport information", "source": "schema", "type": "object" }, { "term": "file_number", "description": "It is the unique alphanumeric code that identifies an individual's passport application.", "source": "property", "schema": "PassportVerificationRequestSchema" }, { "term": "PassportVerificationResponseSchema", "description": "Success response for Verify Passport", "source": "schema", "type": "object" }, { "term": "application_type", "description": "It displays the type of passport application.", "source": "property", "schema": "PassportVerificationResponseSchema" }, { "term": "application_received_date", "description": "It displays when the passport application was received.", "source": "property", "schema": "PassportVerificationResponseSchema" }, { "term": "PhoneDetailsMobile360", "description": "It displays all the list of phone number details linked for individual", "source": "schema", "type": "object" }, { "term": "PostPanBulkResponseSchema", "description": "Success response for verifying a large number of PAN information", "source": "schema", "type": "object" }, { "term": "ReverseGeocodingRequestSchema", "description": "Find the request parameters to convert geographic cooridnates into readable location", "source": "schema", "type": "object" }, { "term": "latitude", "description": "It is the angular distance expressed in degrees of arc north or south of the equator to specify the location.", "source": "property", "schema": "ReverseGeocodingRequestSchema" }, { "term": "longitude", "description": "It is the angular distance expressed in degrees of arc east or west of the equator to specify the location.", "source": "property", "schema": "ReverseGeocodingRequestSchema" }, { "term": "ReverseGeocodingResponseSchema", "description": "Reverse Geocoding success response", "source": "schema", "type": "object" }, { "term": "statecode", "description": "It displays the state's code of the entered coordinates.", "source": "property", "schema": "ReverseGeocodingResponseSchema" }, { "term": "countrycode", "description": "It displays the country's code of the entered coordinates.", "source": "property", "schema": "ReverseGeocodingResponseSchema" }, { "term": "SplitAddress", "description": "It containts the address information in individual components.", "source": "schema", "type": "object" }, { "term": "district", "description": "", "source": "property", "schema": "SplitAddress" }, { "term": "address_line", "description": "", "source": "property", "schema": "SplitAddress" }, { "term": "SplitAddressSchema", "description": "It contains the address information of the individual as present in the voter ID card.", "source": "schema", "type": "object" }, { "term": "UPIv2RequestSchema", "description": "Request Body Schema for UPI V2.", "source": "schema", "type": "object" }, { "term": "UPIv2ResponseSchema", "description": "UPI V2 Response Body Schema", "source": "schema", "type": "object" }, { "term": "InitiateOauthResponseSchema", "description": "Initiate Oauth Response Body Schema", "source": "schema", "type": "object" }, { "term": "expiry", "description": "The expiration date and time of the session, in UTC format. Format `YYYY-MM-DDTHH:mm:ssZ`", "source": "property", "schema": "InitiateOauthResponseSchema" }, { "term": "session_id", "description": "A unique identifier for the session associated with the request.", "source": "property", "schema": "InitiateOauthResponseSchema" }, { "term": "AccessTokenGenerationResponseSchema", "description": "AccessnToken Generation Response Body Schema", "source": "schema", "type": "object" }, { "term": "access_token", "description": "It displays the the access token value. Use this access token to get the user details in fetch user details API.", "source": "property", "schema": "AccessTokenGenerationResponseSchema" }, { "term": "FetchDetailsResponseSchema", "description": "Fetch Details Response Body Schema", "source": "schema", "type": "object" }, { "term": "scopes", "description": "A list of scopes associated with the verification, each representing a specific type of user data that can be accessed.", "source": "property", "schema": "FetchDetailsResponseSchema" }, { "term": "IFSCv2RequestSchema", "description": "Find the request parameters for IFSC Verification V2", "source": "schema", "type": "object" }, { "term": "InitiateOauthRequestSchema", "description": "", "source": "schema", "type": "object" }, { "term": "AccessTokenGenerationRequestSchema", "description": "", "source": "schema", "type": "object" }, { "term": "auth_code", "description": "This is the authcode for generating the access token. The SDK sends the callback using the redirect URL provided in the [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/secure-share) while creating the app. The authcode will be included in the callback sent to the redirect URL.", "source": "property", "schema": "AccessTokenGenerationRequestSchema" }, { "term": "IFSCv2ResponseSchema", "description": "IFSC Verification V2 success response", "source": "schema", "type": "object" }, { "term": "neft", "description": "It displays the status of NEFT.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "imps", "description": "It displays the status of IMPS.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "rtgs", "description": "It displays the status of RTGS.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "ft", "description": "It displays the status of fund transfer.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "nbin", "description": "It displays the National Bank Identification Number (NBIN) information.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "ifsc_subcode", "description": "It displays the subcode of the IFSC information.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "category", "description": "It displays the category of the bank.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "swift_code", "description": "It displays the code that identifies banks and financial institutions worldwide. The code helps pinpoint the specific bank.", "source": "property", "schema": "IFSCv2ResponseSchema" }, { "term": "UpiAdvanceRequestSchema", "description": "Find the request parameters to verify UPI VPA information", "source": "schema", "type": "object" }, { "term": "UpiAdvanceResponseSchema", "description": "UPI 360 success response", "source": "schema", "type": "object" }, { "term": "UpiMobileRequestSchema", "description": "Find the request parameters to fetch the list of UPI VPA", "source": "schema", "type": "object" }, { "term": "additional_vpas", "description": "It is a boolean flag to fetch additional_vpas associated with the phone number in the response.", "source": "property", "schema": "UpiMobileRequestSchema" }, { "term": "UpiMobileResponseSchema", "description": "Success response", "source": "schema", "type": "object" }, { "term": "ValidityDetails", "description": "It contains the validity details.", "source": "schema", "type": "object" }, { "term": "to", "description": "", "source": "property", "schema": "ValidityDetails" }, { "term": "from", "description": "", "source": "property", "schema": "ValidityDetails" }, { "term": "VehicleRcRequestSchema", "description": "Find the request parameters to verify vehicle RC information", "source": "schema", "type": "object" }, { "term": "vehicle_number", "description": "It is the registration number of the vehicle", "source": "property", "schema": "VehicleRcRequestSchema" }, { "term": "VehicleRcResponseSchema", "description": "Verify Vehicle RC success response", "source": "schema", "type": "object" }, { "term": "reg_no", "description": "It displays the registration number of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "class", "description": "It displays the category or type of the vehicle as recognised by the relevant transportation authorities.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "chassis", "description": "It displays the chassis information of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "engine", "description": "It displays the engine number of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_manufacturer_name", "description": "It displays the manufacturer of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "model", "description": "It displays the model number of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_color", "description": "It displays the colour of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "norms_type", "description": "It displays the norms set by the Central Pollution Control Board (CPCB)", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "body_type", "description": "It displays the body type of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "owner_count", "description": "It displays the number of owners of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "owner", "description": "It displays the name of the current owner of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "owner_father_name", "description": "It displays the father's name of the current owner of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "rc_status", "description": "It displays the status of the RC.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "status_as_on", "description": "It displays the particular date of the status of the RC.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "reg_authority", "description": "It displays the name of the registration authority.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "reg_date", "description": "It displays the date of registration of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_manufacturing_month_year", "description": "It displays the month and year of the manufacturing of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "rc_expiry_date", "description": "It displays the date until which the registration of the vehicle is valid.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_tax_upto", "description": "It displays the date until which the tax paid by the owner for the vehicle is valid.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_insurance_company_name", "description": "It displays the name of the insurance company associated with the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_insurance_upto", "description": "It displays the date until which the insurance paid by the owner for the vehicle is valid.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_insurance_policy_number", "description": "It displays the insurance policy number of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "rc_financer", "description": "It displays the name of the financial institution or lender that provided financing for the purchase of a vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "split_present_address", "description": "", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "split_permanent_address", "description": "", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_cubic_capacity", "description": "It displays the cubic capacity of the vehicle's engine.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "gross_vehicle_weight", "description": "It displays the gross weight of the vehicle in kilograms.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "unladen_weight", "description": "It displays the weight of the vehicle without carrying any load in kiolgrams.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_category", "description": "It displays the category of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "rc_standard_cap", "description": "", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_cylinders_no", "description": "It displays the number of cylinders present in the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_seat_capacity", "description": "It displays the number of seats in the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_sleeper_capacity", "description": "It displays the number of beds available in the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "vehicle_standing_capacity", "description": "It displays the number of people that can stand in the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "wheelbase", "description": "It displays distance between the front and rear axles of a vehicle in mm.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "pucc_number", "description": "It displays the Pollution Under Control Certificate (PUCC) number associated with vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "pucc_upto", "description": "It displays till when the PUCC number is valid.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "blacklist_status", "description": "It displays whether the vehicle is blacklisted.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "blacklist_details", "description": "It displays the reasons for blacklisting the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "challan_details", "description": "It displays traffic tickets or citations issued by traffic police or authorities for various traffic violations.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "permit_issue_date", "description": "It displays when the relevant authorities granted permission or authorisation for a specific type of permit associated with the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "permit_number", "description": "It displays the permit number of the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "permit_type", "description": "It displays the type of permit issued to the vehicle.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "permit_valid_from", "description": "It displays the beginning date of the issuance of permit.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "permit_valid_upto", "description": "It displays the end date of the permit.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "non_use_status", "description": "It displays whether the vehicle owner or registrant declared that the vehicle is not in use for a certain period.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "non_use_from", "description": "It displays the beginning date of the non use period.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "non_use_to", "description": "It displays the end date of the non use period.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "national_permit_number", "description": "It displays the permit issued to the vehicle to go outside the home state carrying goods.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "national_permit_upto", "description": "It displays the end date of the permit issued to the vechicle to go outside the home state carrying goods.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "national_permit_issued_by", "description": "It displays the national permit issuer's name.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "is_commercial", "description": "It displays whether the vehicle is for commercial purpose.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "noc_details", "description": "It displays the details of the no objection certificate.", "source": "property", "schema": "VehicleRcResponseSchema" }, { "term": "VoterIdRequestSchema", "description": "Find the request body parameters to verify the voter ID information.", "source": "schema", "type": "object" }, { "term": "epic_number", "description": "It is the unique identification number assigned to each voter ID", "source": "property", "schema": "VoterIdRequestSchema" }, { "term": "RequestFiRequestSchema", "description": "Find the request body parameters to request FI for AA.", "source": "schema", "type": "object" }, { "term": "fi_verification_id", "description": "It is the unique ID you create to identify the financial information request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.", "source": "property", "schema": "RequestFiRequestSchema" }, { "term": "consent_verification_id", "description": "It is the unique ID you created in the Request Consent API to identify the consent request.", "source": "property", "schema": "RequestFiRequestSchema" }, { "term": "fi_from", "description": "It is the beginning date and time of the financial information you require.", "source": "property", "schema": "RequestFiRequestSchema" }, { "term": "fi_to", "description": "It is the ending date and time of the financial information you require.", "source": "property", "schema": "RequestFiRequestSchema" }, { "term": "ConsentRequestSchema", "description": "Find the request body parameters to request consent for AA.", "source": "schema", "type": "object" }, { "term": "customer_identifiers", "description": "It should contain the information related to the individual.", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "consent_expiry", "description": "It is the expiry date and time of the consent request.", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "consent_mode", "description": "It is the type of configuration for handling the financial information of the individual.\nPossible values are\n - `VIEW`: It indicates that the information is for viewing purpose.\n - `STORE`: It indicates that the information is for storing purpose.\n - `QUERY`: It indicates that the information is for querying purposes, including performing searches, filtering results, or making data-driven decisions.\n - `STREAM`: It indicates that the information is for streaming purposes.", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "consent_type", "description": "It displays the type of information you require from the individual.\n\n Possible values are\n - `PROFILE`: It contains the basic information of the individual.\n - `SUMMARY`: It contains the summary of the financial information of the individual.\n - `TRANSACTIONS`: It contains the transactional information of the individual.", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "fi_types", "description": "It displays the type of financial information you require from the individual.\n\n Possible values are\n - `DEPOSIT`", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "consent_start", "description": "It is the start date and time of the consent validity for the individual's financial information.", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "data_life_expiry", "description": "It displays the expiry date of the information fetched.", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "filter", "description": "It contains the filter options to sort the finanical information of the individual.", "source": "property", "schema": "ConsentRequestSchema" }, { "term": "FIData", "description": "", "source": "schema", "type": "object" }, { "term": "fip_id", "description": "It displays the unique ID to identify the financial provider.", "source": "property", "schema": "FIData" }, { "term": "accounts", "description": "It displays the bank account information of the individual.", "source": "property", "schema": "FIData" }, { "term": "FiAccount", "description": "", "source": "schema", "type": "object" }, { "term": "link_ref_number", "description": "It displays the unique identifier associated to specific transactions.", "source": "property", "schema": "FiAccount" }, { "term": "masked_acc_number", "description": "It displays the masked bank account number of the individual.", "source": "property", "schema": "FiAccount" }, { "term": "FiAccountData", "description": "", "source": "schema", "type": "object" }, { "term": "profile", "description": "", "source": "property", "schema": "FiAccountData" }, { "term": "summary", "description": "It contains the summary of the financial information of the individual.", "source": "property", "schema": "FiAccountData" }, { "term": "transactions", "description": "It contains the transactional information of the individual.", "source": "property", "schema": "FiAccountData" }, { "term": "FiResponseSchema", "description": "", "source": "schema", "type": "object" }, { "term": "fi_ref_id", "description": "It displays the unique ID created by Cashfree Payments for reference purpose.", "source": "property", "schema": "FiResponseSchema" }, { "term": "fi_data", "description": "", "source": "property", "schema": "FiResponseSchema" }, { "term": "ConsentResponseSchema", "description": "", "source": "schema", "type": "object" }, { "term": "consent_ref_id", "description": "It displays the unique ID created by Cashfree Payments for reference purpose.", "source": "property", "schema": "ConsentResponseSchema" }, { "term": "consent_redirect_url", "description": "It displays the URL that redirects the individual to the consent request page.", "source": "property", "schema": "ConsentResponseSchema" }, { "term": "VoterIdResponseSchema", "description": "Verify Voter ID success response", "source": "schema", "type": "object" }, { "term": "name_in_regional_lang", "description": "It displays the name of the individual in the individual\u00e2\u20ac\u2122s regional language as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "relation_type", "description": "It displays the type of the relationship with the parent/guardian as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "relation_name", "description": "It displays the name of the parent/guardian as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "relation_name_in_regional_lang", "description": "It displays the name of the parent/guardian in the individual\u00e2\u20ac\u2122s regional language as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "assembly_constituency_number", "description": "It displays the number associated with the assembly constituency as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "assembly_constituency", "description": "It displays the name of the assembly constituency as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "parliamentary_constituency_number", "description": "It displays the number associated with the parliamentary constituency as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "parliamentary_constituency", "description": "It displays the name of the parliamentary constituency as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "part_number", "description": "It displays the part number in the electoral roll.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "part_name", "description": "It displays the part name in the electoral roll.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "serial_number", "description": "It displays the serial number as present in the voter ID card.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "polling_station", "description": "It displays the place where the individual cast votes during elections.", "source": "property", "schema": "VoterIdResponseSchema" }, { "term": "VpaFromPhone500Schema", "description": "Internal error response", "source": "schema", "type": "object" }, { "term": "aadhaarmaskingrequestschema", "description": "Find the request parameters to mask aadhaar information", "source": "schema", "type": "object" }, { "term": "duplicate_verification_id", "description": "400 response for duplicate verification_id", "source": "schema", "type": "object" }, { "term": "invalid_ip_address", "description": "400 response for invalid IP address", "source": "schema", "type": "object" }, { "term": "invaliddoctypeschema", "description": "Invalid document type response", "source": "schema", "type": "object" }, { "term": "v2ErrorResponse404SchemaIpVerification", "description": "IP not found error response", "source": "schema", "type": "object" }, { "term": "x-client-id_missing", "description": "400 response schema for missing x-client-id", "source": "schema", "type": "object" }, { "term": "VrsNameMatchVerification", "description": "Use this API to verify names that have enormous variations. Provide us the names you want to verify, and we will tell you whether they match and provide the reason. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#name-match) and use the information to trigger the validations. The test data are usable only in the test environments such as sandbox.", "source": "operation" }, { "term": "VrsGetKYCLinkStatus", "description": "Use this API to get the status of the verification form. You need to input either the verification_id or reference_id to get the KYC Link status.", "source": "operation" }, { "term": "VrsGenerateKYCLink", "description": "Use this API to generate a verification form to verify the KYC information of your users digitally.", "source": "operation" }, { "term": "VrsGenerateStaticKYCLink", "description": "Use this API to generate a static KYC link to verify the KYC information of your users digitally.", "source": "operation" }, { "term": "VrsDeactivateStaticKYCLink", "description": "Use this API to deactivate a static KYC Link.", "source": "operation" } ] }