Cashfree MCP Server

{ "openapi": "3.0.0", "info": { "version": "2025-01-01", "title": "Cashfree Payment Gateway APIs", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "contact": { "email": "developers@cashfree.com", "name": "API Support", "url": "https://discord.com/invite/QdZkNSxXsB" }, "description": "Cashfree's Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites." }, "externalDocs": { "url": "https://api.cashfree.com/pg", "description": "This url will have the information of all the APIs." }, "servers": [ { "url": "https://sandbox.cashfree.com/pg", "description": "Sandbox server" }, { "url": "https://api.cashfree.com/pg", "description": "Production server" } ], "tags": [ { "name": "Orders", "description": "Collection of APIs to handle orders." }, { "name": "Payments", "description": "Collection of APIs to handle payments." }, { "name": "Refunds", "description": "Collection of APIs to handle refunds." }, { "name": "Settlements", "description": "Collection of APIs to handle settlements." }, { "name": "Payment Links", "description": "Collection of APIs to handle payment links." }, { "name": "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." }, { "name": "softPOS", "description": "Collection of APIs to manage the softPOS agent and order" }, { "name": "Offers", "description": "Collection of APIs to handle offers" }, { "name": "Eligibility", "description": "Collection of APIs to check eligible entities - payment methods, offers, affordability" }, { "name": "Settlement Reconciliation", "description": "Collection of APIs to handle settlements" }, { "name": "PG Reconciliation", "description": "Collection of APIs to handle reconciliation" }, { "name": "Customers", "description": "Collection of APIs to handle customers." }, { "name": "Easy-Split", "description": "Collection of APIs to handle Easy-Split." }, { "name": "Simulation", "description": "Collection of APIs to handle simulation." }, { "name": "Disputes", "description": "Collection of APIs to handle disputes." }, { "name": "Utilities", "description": "Collection of APIs for utility requirements." } ], "components": { "securitySchemes": { "XClientID": { "type": "apiKey", "in": "header", "name": "x-client-id", "description": "Client app ID. You can find your app id in the [merchant dashboard](https://merchant.cashfree.com/merchants/pg/developers/api-keys?env=prod\")." }, "XClientSecret": { "type": "apiKey", "in": "header", "name": "x-client-secret", "description": "Client secret key. You can find your secret in the [merchant dashboard](https://merchant.cashfree.com/merchants/pg/developers/api-keys?env=prod\")." }, "XClientSignatureHeader": { "type": "apiKey", "in": "header", "name": "x-client-signature", "description": "Use this if you do not want to pass the secret key and instead want to use the signature." }, "XPartnerAPIKey": { "type": "apiKey", "in": "header", "name": "x-partner-apikey", "description": "If you are partner and you are making an api call on behalf of a merchant" }, "XPartnerMerchantID": { "type": "apiKey", "in": "header", "name": "x-partner-merchantid", "description": "If you are partner use this to specify the merchant id if you don't have the merchant client app id" } }, "schemas": { "VendorRecon200Response": { "title": "VendorRecon200Response", "description": "Fetch Vendor Recon details success response.", "type": "object", "properties": { "cursor": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "float64" }, "settlement_eligibility_time": { "type": "string" }, "merchant_order_id": { "type": "string" }, "tx_time": { "type": "string" }, "settlement_id": { "type": "integer" }, "settled": { "type": "boolean" }, "fee": { "type": "string" }, "tax": { "type": "string" }, "entity_id": { "type": "string" }, "type": { "type": "string" }, "merchant_vendor_id": { "type": "string" }, "added_on_time": { "type": "string" }, "settlement_time": { "type": "string" }, "settlement_utr": { "type": "string" }, "currency": { "type": "string" }, "debit": { "type": "string" }, "credit": { "type": "string" }, "refund_arn": { "type": "string" } } } }, "limit": { "type": "integer" } } }, "VendorReconRequest": { "title": "VendorReconRequest", "description": "Vendor Recon Request body.", "type": "object", "properties": { "pagination": { "type": "object", "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.", "properties": { "limit": { "type": "integer", "description": "Set the minimum or maximum limit for the number of filtered data. Minimum value: 10, Maximum value: 100." }, "cursor": { "type": "string", "description": "Specifies from where the next set of records should be fetched." } }, "required": [ "limit" ] }, "filters": { "type": "object", "description": "Specify the filters for the desired use case.", "properties": { "settlement_id": { "type": "integer", "format": "int32", "description": "Specify the Settlement ID for which you want to fetch the order details. Relevant for \"View Split Order Details Using Settlement ID\"." }, "merchant_vendor_id": { "type": "string", "description": "Specify the Vendor ID for which you want to fetch the recon details. Relevant for \"Vendor Recon Using Vendor ID & Time Interval\"." }, "start_date": { "type": "string", "description": "Start date for fetching reconciliation details. Relevant for \"Vendor Recon for a Time Period\" and \"Vendor Recon Using Vendor ID & Time Interval\"." }, "end_date": { "type": "string", "description": "End date for fetching reconciliation details. Relevant for \"Vendor Recon for a Time Period\" and \"Vendor Recon Using Vendor ID & Time Interval\"." } } } }, "required": [ "pagination", "filters" ], "example": { "pagination": { "limit": 100, "cursor": null }, "filters": { "merchant_vendor_id": "test01", "start_date": "2024-09-01T00:00:00Z", "end_date": "2024-09-26T23:59:59Z" } } }, "UploadTerminalDocsEntity": { "title": "UploadTerminalDocsEntity", "description": "Upload the terminal documents.", "type": "object", "example": { "cf_terminal_id": 1838, "doc_type": "PHOTOGRAPH", "doc_value": "docs/20260/1838/ymGCq-GIRphoto1", "status": "ACTIVE" }, "properties": { "cf_terminal_id": { "type": "integer" }, "doc_type": { "type": "string" }, "doc_value": { "type": "string" }, "status": { "type": "string" } } }, "AllOffers": { "title": "All Offers", "type": "object", "description": "All offers applicable" }, "ApiError": { "title": "ApiError", "description": "Error at cashfree's server", "example": { "message": "internal Server Error", "code": "internal_error", "type": "api_error" }, "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "help": { "type": "string" }, "type": { "type": "string", "enum": [ "api_error" ], "description": "api_error" } } }, "ApiError404": { "title": "ApiError404", "description": "Error when resource requested is not found", "example": { "message": "something is not found", "code": "somethind_not_found", "type": "invalid_request_error" }, "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "help": { "type": "string" }, "type": { "type": "string", "enum": [ "invalid_request_error" ], "description": "invalid_request_error" } } }, "ApiError409": { "title": "ApiError409", "description": "duplicate request", "example": { "message": "order with same id is already present", "code": "order_already_exists", "type": "invalid_request_error" }, "type": "object", "properties": { "message": { "type": "string" }, "help": { "type": "string" }, "code": { "type": "string" }, "type": { "type": "string", "enum": [ "invalid_request_error" ], "description": "invalid_request_error" } } }, "ApiError502": { "title": "ApiError502", "description": "Error when there is error at partner bank", "example": { "message": "something is not found", "code": "bank_processing_failure", "type": "api_error" }, "type": "object", "properties": { "message": { "type": "string" }, "help": { "type": "string" }, "code": { "type": "string", "description": "`bank_processing_failure` will be returned here to denote failure at bank.\n" }, "type": { "type": "string", "enum": [ "api_error" ], "description": "api_error" } } }, "App": { "title": "App", "description": "App payment method", "example": { "channel": "link", "provider": "gpay", "phone": "8474090552" }, "type": "object", "properties": { "channel": { "type": "string", "description": "Specify the channel through which the payment must be processed." }, "provider": { "type": "string", "enum": [ "gpay", "phonepe", "ola", "paytm", "amazon", "airtel", "freecharge", "mobikwik", "jio" ], "description": "Specify the provider through which the payment must be processed." }, "phone": { "type": "string", "description": "Customer phone number associated with a wallet for payment." } }, "required": [ "channel", "provider", "phone" ] }, "AppPaymentMethod": { "title": "AppPaymentMethod", "description": "App payment method", "example": { "app": { "channel": "link", "provider": "gpay", "phone": "8474090552" } }, "type": "object", "properties": { "app": { "$ref": "#/components/schemas/App" } }, "required": [ "app" ] }, "AuthenticationError": { "title": "AuthenticationError", "description": "Error if api keys are wrong", "example": { "message": "authentication Failed", "code": "request_failed", "type": "authentication_error" }, "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "type": { "type": "string", "description": "authentication_error" } } }, "AuthorizationInPaymentsEntity": { "title": "AuthorizationInPayments", "description": "If preauth enabled for account you will get this body", "example": { "action": "CAPTURE", "status": "PENDING", "captured_amount": 100, "start_time": "2022-02-09T18:04:34+05:30", "end_time": "2022-02-19T18:04:34+05:30", "approve_by": "2022-02-09T18:04:34+05:30", "action_reference": "6595231908096894505959", "action_time": "2022-08-03T16:09:51" }, "type": "object", "properties": { "action": { "type": "string", "enum": [ "CAPTURE", "VOID" ], "description": "One of CAPTURE or VOID" }, "status": { "type": "string", "enum": [ "SUCCESS", "PENDING" ], "description": "One of SUCCESS or PENDING" }, "captured_amount": { "type": "number", "description": "The captured amount for this authorization request" }, "start_time": { "type": "string", "description": "Start time of this authorization hold (only for UPI)" }, "end_time": { "type": "string", "description": "End time of this authorization hold (only for UPI)" }, "approve_by": { "type": "string", "description": "Approve by time as passed in the authorization request (only for UPI)" }, "action_reference": { "type": "string", "description": "CAPTURE or VOID reference number based on action " }, "action_time": { "type": "string", "description": "Time of action (CAPTURE or VOID)" } } }, "AuthorizeOrderRequest": { "title": "AuthorizeOrderRequest", "description": "Request to capture or void transaction", "example": { "action": "CAPTURE", "amount": 100 }, "type": "object", "properties": { "action": { "type": "string", "enum": [ "CAPTURE", "VOID" ], "description": "Type of authorization to run. Can be one of 'CAPTURE' , 'VOID'" }, "amount": { "type": "number", "description": "The amount if you are running a 'CAPTURE'" } } }, "BadRequestError": { "title": "BadRequestError", "description": "Invalid request received from client", "example": { "message": "bad URL, please check API documentation", "code": "request_failed", "type": "invalid_request_error" }, "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "help": { "type": "string" }, "type": { "type": "string", "enum": [ "invalid_request_error" ] } } }, "Card": { "title": "Card", "description": "Card Payment method", "required": [ "channel" ], "example": { "channel": "link", "card_number": "4111111111111111", "card_holder_name": "Tushar Gupta", "card_expiry_mm": "06", "card_expiry_yy": "22", "card_cvv": "900", "address_line_one": "Address line 1", "address_line_two": "Address line 2", "city": "Minnehaha", "zip_code": "57109", "country": "United States", "country_code": "US", "state": "South Dakota", "state_code": "SD" }, "type": "object", "properties": { "channel": { "type": "string", "enum": [ "link", "post" ], "description": "The channel for card payments can be \"link\" or \"post\". Post is used for seamless OTP payments where merchant captures OTP on their own page." }, "card_number": { "type": "string", "description": "Customer card number for plain card transactions. Token pan number for tokenized card transactions." }, "card_holder_name": { "type": "string", "description": "Customer name mentioned on the card." }, "card_expiry_mm": { "type": "string", "description": "Card expiry month for plain card transactions. Token expiry month for tokenized card transactions." }, "card_expiry_yy": { "type": "string", "description": "Card expiry year for plain card transactions. Token expiry year for tokenized card transactions." }, "card_cvv": { "type": "string", "description": "CVV mentioned on the card." }, "instrument_id": { "type": "string", "description": "instrument id of saved card. Required only to make payment using saved instrument." }, "cryptogram": { "type": "string", "description": "cryptogram received from card network. Required only for tokenized card transactions." }, "token_requestor_id": { "type": "string", "description": "TRID issued by card networks. Required only for tokenized card transactions." }, "token_reference_id": { "type": "string", "description": "Token Reference Id provided by Diners for Guest Checkout Token. Required only for Diners cards." }, "token_type": { "enum": [ "ISSUER_TOKEN", "NETWORK_GC_TOKEN", "ISSUER_GC_TOKEN" ], "type": "string" }, "card_display": { "type": "string", "description": "last 4 digits of original card number. Required only for tokenized card transactions." }, "card_alias": { "type": "string", "description": "Card alias as returned by Cashfree Vault API." }, "card_bank_name": { "type": "string", "enum": [ "Kotak", "ICICI", "RBL", "BOB", "Standard Chartered" ], "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" }, "address_line_one": { "type": "string", "description": "First line of the address." }, "address_line_two": { "type": "string", "description": "Second line of the address." }, "city": { "type": "string", "description": "City Name." }, "zip_code": { "type": "string", "description": "Pin Code/Zip Code." }, "country": { "type": "string", "description": "Country Name." }, "country_code": { "type": "string", "description": "Country Code. Should be in ISO 2 format (ie. US for United States)" }, "state": { "type": "string", "description": "State Name." }, "state_code": { "type": "string", "description": "State Code. Should be in ISO 2 format (ie. FL for Florida)" }, "emi_tenure": { "type": "integer", "description": "EMI tenure selected by the user" } } }, "CardArray": { "title": "card array", "description": "short code for credit card, debit card, prepaid card", "type": "string", "example": "dc" }, "CardEMI": { "title": "CardEMI", "description": "Payment method for card emi", "required": [ "channel", "card_number", "card_expiry_mm", "card_expiry_yy", "card_cvv", "card_bank_name", "emi_tenure" ], "example": { "channel": "link", "card_bank_name": "hdfc", "card_number": "4111111111111111", "card_holder_name": "Tushar Gupta", "card_expiry_mm": "06", "card_expiry_yy": "22", "card_cvv": "900", "emi_tenure": 3 }, "type": "object", "properties": { "channel": { "type": "string", "description": "The channel for card payments will always be \"link\"" }, "card_number": { "type": "string", "description": "Customer card number." }, "card_holder_name": { "type": "string", "description": "Customer name mentioned on the card." }, "card_expiry_mm": { "type": "string", "description": "Card expiry month." }, "card_expiry_yy": { "type": "string", "description": "Card expiry year." }, "card_cvv": { "type": "string", "description": "CVV mentioned on the card." }, "card_alias": { "type": "string", "description": "Card alias as returned by Cashfree Vault API" }, "card_bank_name": { "type": "string", "enum": [ "hdfc", "kotak", "icici", "rbl", "bob", "standard chartered", "axis", "au", "yes", "sbi", "fed", "hsbc", "citi", "amex" ], "description": "Card bank name, required for EMI payments. This is the bank user has selected for EMI. One of [\"hdfc, \"kotak\", \"icici\", \"rbl\", \"bob\", \"standard chartered\", \"axis\", \"au\", \"yes\", \"sbi\", \"fed\", \"hsbc\", \"citi\", \"amex\"]" }, "emi_tenure": { "type": "integer", "description": "EMI tenure selected by the user" } } }, "CardEMIPaymentMethod": { "title": "CardEMIPaymentMethod", "description": "Complete card emi payment method", "example": { "emi": { "channel": "link", "card_number": "4111111111111111", "card_holder_name": "Tushar Gupta", "card_expiry_mm": "06", "card_expiry_yy": "22", "card_cvv": "900", "card_bank_name": "kotak", "emi_tenure": 3 } }, "type": "object", "properties": { "emi": { "$ref": "#/components/schemas/CardEMI" } }, "required": [ "emi" ] }, "CardPaymentMethod": { "title": "CardPaymentMethod", "description": "The card payment object is used to make payment using either plain card number, saved card instrument id or using cryptogram", "example": { "card": { "channel": "link", "card_number": "4111111111111111", "card_holder_name": "Tushar Gupta", "card_expiry_mm": "06", "card_expiry_yy": "22", "card_cvv": "900" } }, "type": "object", "properties": { "card": { "$ref": "#/components/schemas/Card" } }, "required": [ "card" ] }, "CardlessEMI": { "title": "CardlessEMI", "description": "Request body for cardless emi payment method", "example": { "channel": "link", "provider": "kotak", "phone": "7768913241", "emi_tenure": 3 }, "type": "object", "properties": { "channel": { "type": "string", "description": "The channel for cardless EMI is always `link`" }, "provider": { "type": "string", "enum": [ "flexmoney", "zestmoney", "hdfc", "icici", "cashe", "idfc", "kotak", "snapmint", "bharatx" ], "description": "One of [`flexmoney`, `zestmoney`, `hdfc`, `icici`, `cashe`, `idfc`, `kotak`, `snapmint`, `bharatx`]" }, "phone": { "type": "string", "description": "Customers phone number for this payment instrument. If the customer is not eligible you will receive a 400 error with type as 'invalid_request_error' and code as 'invalid_request_error'" }, "emi_tenure": { "type": "integer", "description": "EMI tenure for the selected provider. This is mandatory when provider is one of [`hdfc`, `icici`, `cashe`, `idfc`, `kotak`]" } } }, "CardlessEMIEntity": { "title": "CardlessEMIEntity", "description": "cardless EMI object", "type": "object", "properties": { "payment_method": { "type": "string", "minLength": 3, "maxLength": 50, "example": "idfc" }, "emi_plans": { "type": "array", "items": { "$ref": "#/components/schemas/EMIPlansArray" } } }, "example": { "payment_method": "idfc", "emi_plans": [ { "tenure": 1, "interest_rate": 10, "currency": "INR", "emi": 400, "total_interest": 10, "total_amount": 40 } ] } }, "CardlessEMIPaymentMethod": { "title": "CardlessEMIPaymentMethod", "description": "cardless EMI payment method object", "example": { "channel": "link", "provider": "flexmoney", "phone": 781234121 }, "type": "object", "properties": { "cardless_emi": { "$ref": "#/components/schemas/CardlessEMI" } }, "required": [ "cardless_emi" ] }, "CardlessEMIQueries": { "title": "QueriesObject", "type": "object", "description": "cardless EMI query object", "example": { "order_id": "orderYB1X69LgzUQWiSxYDF", "amount": 20, "customer_details": { "customer_phone": "93838393833" } }, "properties": { "order_id": { "type": "string", "description": "OrderId of the order. Either of `order_id` or `amount` is mandatory.", "minLength": 3, "maxLength": 50, "format": "string", "example": "orderYB1X69LgzUQWiSxYDF" }, "amount": { "type": "number", "description": "Amount of the order. OrderId of the order. Either of `order_id` or `amount` is mandatory.", "minimum": 1, "example": 100 }, "customer_details": { "allOf": [ { "$ref": "#/components/schemas/CustomerDetailsCardlessEMI" } ], "example": { "customer_details": { "customer_phone": "93838393833" } } } } }, "CashbackDetails": { "title": "CashbackDetails", "description": "Cashback detail boject", "example": { "cashback_type": "percentage", "cashback_value": "20", "max_cashback_amount": "150" }, "type": "object", "properties": { "cashback_type": { "type": "string", "description": "Type of discount", "enum": [ "flat", "percentage" ], "minLength": 1, "maxLength": 50 }, "cashback_value": { "type": "number", "format": "float64", "description": "Value of Discount." }, "max_cashback_amount": { "type": "number", "format": "float64", "description": "Maximum Value of Cashback allowed." } }, "required": [ "cashback_type", "cashback_value", "max_cashback_amount" ] }, "CreateCustomerRequest": { "title": "CreateCustomerRequest", "description": "Request body to create a customer at cashfree", "type": "object", "properties": { "customer_phone": { "type": "string", "description": "Customer Phone Number", "minLength": 10, "maxLength": 10, "example": "9999999999" }, "customer_email": { "type": "string", "description": "Customer Email", "example": "example@test.com" }, "customer_name": { "type": "string", "description": "Customer Name", "example": "YourCustomer" } }, "required": [ "customer_phone" ] }, "SimulateRequest": { "title": "SimulateRequest", "description": "simulate payment request object", "type": "object", "properties": { "entity": { "type": "string", "enum": [ "PAYMENTS", "SUBS_PAYMENTS" ], "description": "Entity type should be PAYMENTS or SUBS_PAYMENTS only." }, "entity_id": { "type": "string", "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" }, "entity_simulation": { "$ref": "#/components/schemas/EntitySimulationRequest" } }, "required": [ "entity", "entity_id", "entity_simulation" ] }, "CreateLinkRequest": { "title": "CreateLinkRequest", "description": "Request paramenters for link creation", "example": { "customer_details": { "customer_email": "john@cashfree.com", "customer_name": "John Doe", "customer_phone": "9999999999" }, "link_amount": 100, "link_auto_reminders": true, "link_currency": "INR", "link_expiry_time": "2021-10-14T15:04:05+05:30", "link_id": "my_link_id", "link_meta": { "notify_url": "https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net", "return_url": "https://www.cashfree.com/devstudio/thankyou", "upi_intent": false }, "link_minimum_partial_amount": 20, "link_notes": { "key_1": "value_1", "key_2": "value_2" }, "link_notify": { "send_email": true, "send_sms": false }, "link_partial_payments": true, "link_purpose": "Payment for PlayStation 11", "order_splits": [ { "vendor_id": "Jane", "amount": 1.45, "tags": { "address": "Hyderabad" } }, { "vendor_id": "Barbie", "amount": 3.45, "tags": { "address": "Bengaluru, India" } } ] }, "type": "object", "properties": { "link_id": { "type": "string", "description": "Unique Identifier (provided by merchant) for the Link. Alphanumeric and only - and _ allowed (50 character limit). Use this for other link-related APIs.", "maxLength": 50 }, "link_amount": { "type": "number", "format": "double", "description": "Amount to be collected using this link. Provide upto two decimals for paise." }, "link_currency": { "type": "string", "description": "Currency for the payment link. Default is INR. Contact care@cashfree.com to enable new currencies.", "minimum": 1 }, "link_purpose": { "type": "string", "description": "A brief description for which payment must be collected. This is shown to the customer.", "maxLength": 500 }, "customer_details": { "$ref": "#/components/schemas/LinkCustomerDetailsEntity" }, "link_partial_payments": { "type": "boolean", "description": "If \"true\", customer can make partial payments for the link." }, "link_minimum_partial_amount": { "type": "number", "format": "double", "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." }, "link_expiry_time": { "type": "string", "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." }, "link_notify": { "$ref": "#/components/schemas/LinkNotifyEntity" }, "link_auto_reminders": { "type": "boolean", "description": "If \"true\", reminders will be sent to customers for collecting payments." }, "link_notes": { "$ref": "#/components/schemas/LinkNotesEntity" }, "link_meta": { "$ref": "#/components/schemas/LinkMetaResponseEntity" }, "order_splits": { "type": "array", "description": "If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount.", "items": { "$ref": "#/components/schemas/VendorSplit" }, "example": [ { "amount": 10, "vendor": "john" } ] } }, "required": [ "link_amount", "link_currency", "link_id", "customer_details", "link_purpose" ] }, "CreateOfferRequest": { "title": "CreateOfferRequest", "description": "create offer backend request object", "type": "object", "properties": { "offer_meta": { "allOf": [ { "$ref": "#/components/schemas/OfferMeta" } ], "example": { "$ref": "#/components/schemas/OfferMeta/example" } }, "offer_tnc": { "allOf": [ { "$ref": "#/components/schemas/OfferTnc" } ], "example": { "$ref": "#/components/schemas/OfferTnc/example" } }, "offer_details": { "allOf": [ { "$ref": "#/components/schemas/OfferDetails" } ], "example": { "$ref": "#/components/schemas/OfferDetails/example" } }, "offer_validations": { "allOf": [ { "$ref": "#/components/schemas/OfferValidations" } ], "example": { "$ref": "#/components/schemas/OfferValidations/example" } } }, "required": [ "offer_meta", "offer_tnc", "offer_details", "offer_validations" ] }, "CreateOrderRequest": { "title": "CreateOrderRequest", "description": "Request body to create an order at cashfree", "type": "object", "properties": { "order_id": { "type": "string", "description": "Order identifier present in your system. Alphanumeric, '_' and '-' only", "minLength": 3, "maxLength": 45, "example": "your-order-id" }, "order_amount": { "type": "number", "description": "Bill amount for the order. Provide upto two decimals. 10.15 means Rs 10 and 15 paisa", "format": "double", "example": 10.15, "minimum": 1 }, "order_currency": { "type": "string", "description": "Currency for the order. INR if left empty. Contact care@cashfree.com to enable new currencies.", "example": "INR" }, "cart_details": { "allOf": [ { "$ref": "#/components/schemas/CartDetails" } ] }, "customer_details": { "allOf": [ { "$ref": "#/components/schemas/CustomerDetails" } ], "example": { "customer_id": "7112AAA812234", "customer_email": "john@cashfree.com", "customer_phone": "9908734801" } }, "terminal": { "allOf": [ { "$ref": "#/components/schemas/TerminalDetails" } ], "example": { "terminal_phone_no": "6309291183", "terminal_id": "terminal-1212", "terminal_type": "SPOS" } }, "order_meta": { "allOf": [ { "$ref": "#/components/schemas/OrderMeta" } ], "example": { "return_url": "https://www.cashfree.com/devstudio/thankyou", "payment_methods": "cc,dc" } }, "order_expiry_time": { "type": "string", "format": "ISO8601", "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", "example": "2021-07-02T10:20:12+05:30" }, "order_note": { "type": "string", "description": "Order note for reference.", "example": "Test order", "minLength": 3, "maxLength": 200 }, "order_tags": { "allOf": [ { "$ref": "#/components/schemas/OrderTags" } ], "example": { "name": "John Doe", "city": "Bangalore" } }, "order_splits": { "type": "array", "description": "If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount.", "items": { "$ref": "#/components/schemas/VendorSplit" }, "example": [ { "amount": 10, "vendor": "john" } ] }, "products": { "title": "products", "type": "object", "description": "Use this to set configurations for the products like One Click Checkout, Verify and Pay, if they are enabled for your account", "properties": { "one_click_checkout": { "allOf": [ { "$ref": "#/components/schemas/ProductDetails" } ] }, "verify_pay": { "allOf": [ { "$ref": "#/components/schemas/ProductDetails" } ] } } } }, "required": [ "order_amount", "order_currency", "customer_details" ] }, "UpdateOrderExtendedRequest": { "title": "Update Order Extended", "description": "Request Body to Update extended data related to order", "type": "object", "properties": { "shipment_details": { "type": "array", "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.", "items": { "$ref": "#/components/schemas/ShipmentDetails" } }, "order_delivery_status": { "allOf": [ { "$ref": "#/components/schemas/OrderDeliveryStatus" } ], "example": { "status": "SHIPPED", "reason": "shipped" } } }, "required": [ "shipment_details" ] }, "CreateTerminalRequest": { "title": "Create Terminal", "description": "Request body to create a terminal", "example": { "terminal_id": "someTerminalID", "terminal_name": "Jane Doe", "terminal_email": "john@cashfree.com", "terminal_meta": null, "terminal_type": "STOREFRONT", "terminal_phone_no": "9876543210", "terminal_note": "POS Vertical", "terminal_address": "Bangalore" }, "type": "object", "properties": { "terminal_id": { "type": "string", "description": "merchant’s internal terminal id", "minLength": 3, "maxLength": 100 }, "terminal_phone_no": { "type": "string", "description": "phone number assigned to the terminal", "minLength": 10, "maxLength": 10 }, "terminal_name": { "type": "string", "description": "terminal name to be assigned by merchants", "minLength": 3, "maxLength": 100 }, "terminal_address": { "type": "string", "description": "address of the terminal. required for STOREFRONT", "minLength": 1, "maxLength": 100 }, "terminal_email": { "type": "string", "description": "terminal email ID of the AGENT/STOREFRONT assigned by merchants.", "minLength": 1, "maxLength": 100 }, "terminal_note": { "type": "string", "description": "additional note for terminal", "minLength": 1, "maxLength": 100 }, "terminal_type": { "type": "string", "description": "mention the terminal type. possible values - AGENT, STOREFRONT.", "minLength": 1, "maxLength": 100 }, "terminal_meta": { "type": "object", "description": "terminal metadata. required field for storefront.", "properties": { "terminal_operator": { "description": "name of the STOREFRONT operator.", "type": "string" } } } }, "required": [ "terminal_id", "terminal_email", "terminal_type", "terminal_phone_no", "terminal_name" ] }, "CreateTerminalTransactionRequest": { "title": "Create Terminal Transaction", "description": "Request body to create a terminal transaction", "example": { "cf_order_id": "12345", "cf_terminal_id": 54321, "payment_method": "john@cashfree.com", "terminal_phone_no": "9898989898", "add_invoice": false }, "type": "object", "properties": { "cf_order_id": { "description": "cashfree order ID that was returned while creating an order.", "type": "string" }, "cf_terminal_id": { "description": "cashfree terminal id. this is a required parameter when you do not provide the terminal phone number.", "type": "string" }, "payment_method": { "type": "string", "description": "mention the payment method used for the transaction. possible values - QR_CODE, LINK.", "minLength": 3, "maxLength": 100 }, "terminal_phone_no": { "type": "string", "description": "agent mobile number assigned to the terminal. this is a required parameter when you do not provide the cf_terminal_id.", "minLength": 10, "maxLength": 10 }, "add_invoice": { "type": "boolean", "description": "make it true to have request be sent to create a Dynamic GST QR Code." } }, "required": [ "cf_order_id", "payment_method" ] }, "OnboardSoundboxVpaRequest": { "title": "Onboard Soundbox Vpa", "description": "Request body to onboard soundbox vpa", "example": { "vpa": "cf.vpa-epos-gamma1018696837085fad68@sim", "cf_terminal_id": 3708, "device_serial_no": "abtest123", "merchant_name": "merchant-test", "language": "English" }, "type": "object", "properties": { "vpa": { "description": "Terminal Vpa ,that need to onboard on soundbox", "type": "string" }, "cf_terminal_id": { "description": "cashfree terminal id.", "type": "string" }, "device_serial_no": { "type": "string", "description": "Device Serial No of soundbox" }, "merchant_name": { "type": "string", "description": "Merchant Name that need to onboard on soundbox" }, "language": { "type": "string", "description": "language of soundbox,currently English, Hindi, Tamil" } }, "required": [ "vpa", "cf_terminal_id", "device_serial_no" ] }, "UpdateSoundboxVpaRequest": { "title": "Update Soundbox Vpa", "description": "Request body to update soundbox vpa", "example": { "vpa": "cf.vpa-epos-gamma1018696837085fad68@sim", "cf_terminal_id": 3708, "merchant_name": "merchant-test", "language": "English" }, "type": "object", "properties": { "vpa": { "description": "Terminal Vpa,for which we need to update details.", "type": "string" }, "cf_terminal_id": { "description": "cashfree terminal id.", "type": "string" }, "merchant_name": { "type": "string", "description": "Merchant Name that need to updated on soundbox" }, "language": { "type": "string", "description": "language of soundbox,currently English, Hindi, Tamil" } }, "required": [ "vpa", "cf_terminal_id", "device_serial_no" ] }, "DemapSoundboxVpaRequest": { "title": "Demap Soundbox Vpa", "description": "Request body to demap soundbox vpa", "example": { "cf_terminal_id": 3708, "device_serial_no": "abtest123" }, "type": "object", "properties": { "cf_terminal_id": { "description": "cashfree terminal id.", "type": "string" }, "device_serial_no": { "type": "string", "description": "Device Serial No of soundbox that need to demap." } }, "required": [ "cf_terminal_id", "device_serial_no" ] }, "CryptogramEntity": { "title": "CryptogramEntity", "description": "Crytogram Card object", "example": { "instrument_id": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10", "token_requestor_id": "22457512314", "card_number": "4491365621601472", "card_expiry_mm": "06", "card_expiry_yy": "2025", "cryptogram": "AQBBBBBBZatIlaIAmWKSghwBBBB=", "card_display": "1234" }, "properties": { "instrument_id": { "type": "string", "description": "instrument_id of saved instrument" }, "token_requestor_id": { "type": "string", "description": "TRID issued by card networks" }, "card_number": { "type": "string", "description": "token pan number" }, "card_expiry_mm": { "type": "string", "description": "token pan expiry month" }, "card_expiry_yy": { "type": "string", "description": "token pan expiry year" }, "cryptogram": { "type": "string", "description": "cryptogram" }, "card_display": { "type": "string", "description": "last 4 digits of original card number" } } }, "CartDetails": { "title": "CartDetails", "description": "The cart details that are necessary like shipping address, billing address and more.", "type": "object", "properties": { "customer_note": { "type": "string" }, "shipping_charge": { "type": "number", "format": "double" }, "cart_name": { "type": "string", "description": "Name of the cart." }, "customer_shipping_address": { "$ref": "#/components/schemas/CartAddress" }, "customer_billing_address": { "$ref": "#/components/schemas/CartAddress" }, "cart_items": { "type": "array", "items": { "$ref": "#/components/schemas/CartItem" } } } }, "CartAddress": { "title": "CartAddress", "description": "Address given for cart details.", "properties": { "full_name": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "pincode": { "type": "string" }, "address_1": { "type": "string" }, "address_2": { "type": "string" } } }, "CartItem": { "title": "CartItem", "description": "Each item in the cart.", "properties": { "item_id": { "type": "string", "description": "Unique identifier of the item" }, "item_name": { "type": "string", "description": "Name of the item" }, "item_description": { "type": "string", "description": "Description of the item" }, "item_tags": { "type": "array", "items": { "type": "string" }, "description": "Tags attached to that item" }, "item_details_url": { "type": "string", "description": "Item details url" }, "item_image_url": { "type": "string", "description": "Item image url" }, "item_original_unit_price": { "type": "number", "format": "double", "description": "Original price" }, "item_discounted_unit_price": { "type": "number", "format": "double", "description": "Discounted Price" }, "item_currency": { "type": "string", "description": "Currency of the item." }, "item_quantity": { "type": "number", "format": "int32", "description": "Quantity if that item" } } }, "CustomerDetails": { "title": "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.", "example": { "customer_id": "7112AAA812234", "customer_email": "john@cashfree.com", "customer_phone": "9908734801", "customer_name": "John Doe", "customer_bank_account_number": "1518121112", "customer_bank_ifsc": "XITI0000001", "customer_bank_code": 3333, "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10" }, "type": "object", "properties": { "customer_id": { "type": "string", "description": "A unique identifier for the customer. Use alphanumeric values only.", "minLength": 3, "maxLength": 50 }, "customer_email": { "type": "string", "description": "Customer email address.", "minLength": 3, "maxLength": 100 }, "customer_phone": { "type": "string", "description": "Customer phone number.", "minLength": 10, "maxLength": 10 }, "customer_name": { "type": "string", "description": "Name of the customer.", "minLength": 3, "maxLength": 100 }, "customer_bank_account_number": { "type": "string", "description": "Customer bank account. Required if you want to do a bank account check (TPV)", "minLength": 3, "maxLength": 20 }, "customer_bank_ifsc": { "type": "string", "description": "Customer bank IFSC. Required if you want to do a bank account check (TPV)" }, "customer_bank_code": { "type": "number", "description": "Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV)" }, "customer_uid": { "type": "string", "description": "Customer identifier at Cashfree. You will get this when you create/get customer" } }, "required": [ "customer_id", "customer_phone" ] }, "CustomerDetailsResponse": { "title": "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.", "example": { "customer_id": "7112AAA812234", "customer_email": "john@cashfree.com", "customer_phone": "9908734801", "customer_name": "John Doe", "customer_bank_account_number": "1518121112", "customer_bank_ifsc": "XITI0000001", "customer_bank_code": 3333, "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10" }, "type": "object", "properties": { "customer_id": { "type": "string", "description": "A unique identifier for the customer. Use alphanumeric values only.", "minLength": 3, "maxLength": 50 }, "customer_email": { "type": "string", "description": "Customer email address.", "minLength": 3, "maxLength": 100 }, "customer_phone": { "type": "string", "description": "Customer phone number.", "minLength": 10, "maxLength": 10 }, "customer_name": { "type": "string", "description": "Name of the customer.", "minLength": 3, "maxLength": 100 }, "customer_bank_account_number": { "type": "string", "description": "Customer bank account. Required if you want to do a bank account check (TPV)", "minLength": 3, "maxLength": 20 }, "customer_bank_ifsc": { "type": "string", "description": "Customer bank IFSC. Required if you want to do a bank account check (TPV)" }, "customer_bank_code": { "type": "number", "description": "Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV)" }, "customer_uid": { "type": "string", "description": "Customer identifier at Cashfree. You will get this when you create/get customer" } } }, "ShipmentDetails": { "title": "ShipmentDetails", "description": "Shipment details associated with shipping of order like tracking company, tracking number,tracking urls etc.", "properties": { "tracking_company": { "type": "string", "description": "Tracking company name associated with order.", "example": "DHL" }, "tracking_urls": { "type": "array", "description": "Tracking Urls associated with order.", "items": { "type": "string", "example": "https://dhl.com/track/123456" } }, "tracking_numbers": { "type": "array", "description": "Tracking Numbers associated wih order.", "items": { "type": "string", "example": "TRACK654321" } } }, "required": [ "tracking_company", "tracking_urls", "tracking_numbers" ] }, "TerminalData": { "description": "Terminal Data in the create order response", "example": { "agent_mobile_number": "9876543214", "cf_terminal_id": 1838, "merchant_terminal_id": "ahdsgadjhgfaj7137e", "terminal_type": "STOREFRONT" }, "properties": { "agent_mobile_number": { "type": "string" }, "cf_terminal_id": { "type": "integer" }, "merchant_terminal_id": { "type": "string" }, "terminal_type": { "type": "string" } }, "title": "TerminalData", "type": "object" }, "OrderDeliveryStatus": { "title": "OrderDeliveryStatus", "description": "Order delivery Status associated with order.", "properties": { "status": { "type": "string", "enum": [ "AWAITING_PICKUP", "CANCELLED", "SELF_FULFILLED", "PICKED_UP", "SHIPPED", "IN_TRANSIT", "DELAY_COURIER_COMPANY_ISSUES", "DELAY_INCORRECT_ADDRESS", "DELAY_SELLER_ISSUES", "REACHED_DESTINATION_HUB", "OUT_FOR_DELIVERY", "DELIVERED", "POTENTIAL_RTO_DELIVERY_ATTEMPTED", "RTO", "LOST", "DAMAGED", "UNTRACKABLE_404", "MANUAL_INTERVENTION_BROKEN_URL", "ASSOCIATED_WITH_RETURN_PICKUP", "UNSERVICEABLE" ], "description": "Delivery status of order", "example": "CANCELLED" }, "reason": { "type": "string", "description": "Reason of provided order delivery status. This is optional field.", "example": "cancelled due to wrong address" } }, "required": [ "status" ] }, "CustomerDetailsCardlessEMI": { "title": "CustomerDetailsObject", "description": "Details of the customer for whom eligibility is being checked.", "type": "object", "example": { "customer_phone": "9898989898" }, "properties": { "customer_phone": { "type": "string", "description": "Phone Number of the customer", "minLength": 3, "maxLength": 50, "example": "9898989898" } }, "required": [ "customer_phone" ] }, "CustomerEntity": { "title": "CustomerEntity", "type": "object", "description": "The complete customer entity", "example": { "$ref": "#/components/examples/customer_entity_example" }, "properties": { "customer_uid": { "type": "string", "description": "unique id generated by cashfree for your customer" }, "customer_phone": { "type": "string", "description": "Customer Phone Number" }, "customer_email": { "type": "string", "description": "Customer Email" }, "customer_name": { "type": "string", "description": "Customer Name" } } }, "DiscountDetails": { "title": "DiscountDetails", "description": "detils of the discount object of offer", "example": { "discount_type": "flat", "discount_value": "10", "max_discount_amount": "10" }, "type": "object", "properties": { "discount_type": { "type": "string", "description": "Type of discount", "enum": [ "flat", "percentage" ], "minLength": 3, "maxLength": 50 }, "discount_value": { "type": "number", "format": "float64", "description": "Value of Discount." }, "max_discount_amount": { "type": "number", "format": "float64", "description": "Maximum Value of Discount allowed." } }, "required": [ "discount_type", "discount_value", "max_discount_amount" ] }, "EMIPlansArray": { "title": "EMIPlansArray", "description": "Single EMI object", "type": "object", "properties": { "tenure": { "type": "integer", "example": 3 }, "interest_rate": { "type": "number", "example": 24 }, "currency": { "type": "string", "minLength": 3, "maxLength": 50, "example": "INR" }, "emi": { "type": "integer", "example": 3468 }, "total_interest": { "type": "integer", "example": 404 }, "total_amount": { "type": "integer", "example": 10404 } } }, "EligibilityCardlessEMIEntity": { "title": "EligibilityCardlessEMIEntity", "description": "Carless EMI eligible entity", "type": "object", "properties": { "eligibility": { "type": "boolean", "example": true }, "entity_type": { "type": "string", "example": "cardlessemi" }, "entity_value": { "type": "string", "example": "idfc" }, "entity_details": { "allOf": [ { "$ref": "#/components/schemas/CardlessEMIEntity" } ], "example": { "$ref": "#/components/schemas/CardlessEMIEntity/example" } } } }, "EligibilityFetchCardlessEMIRequest": { "title": "EligibilityFetchCardlessEMIRequest", "description": "eligibilty request for cardless", "example": { "queries": { "$ref": "#/components/schemas/CardlessEMIQueries/example" } }, "type": "object", "properties": { "queries": { "$ref": "#/components/schemas/CardlessEMIQueries" } }, "required": [ "queries" ] }, "EligibilityFetchOffersRequest": { "title": "EligibilityFetchOffersRequest", "type": "object", "description": "Eligiblty API request", "example": { "queries": { "$ref": "#/components/schemas/OfferQueries/example" } }, "properties": { "queries": { "$ref": "#/components/schemas/OfferQueries" }, "filters": { "$ref": "#/components/schemas/OfferFilters" } }, "required": [ "queries" ] }, "EligibilityFetchPaylaterRequest": { "title": "EligibilityFetchPaylaterRequest", "description": "Request to get eligible paylater payment methods", "example": { "queries": { "$ref": "#/components/schemas/CardlessEMIQueries/example" } }, "type": "object", "properties": { "queries": { "$ref": "#/components/schemas/CardlessEMIQueries" } }, "required": [ "queries" ] }, "EligibilityFetchPaymentMethodsRequest": { "title": "EligibilityFetchPaymentMethodsRequest", "description": "eligibilty request to find eligible payment method", "example": { "queries": { "$ref": "#/components/schemas/PaymentMethodsQueries/example" }, "filters": { "$ref": "#/components/schemas/PaymentMethodsFilters/example" } }, "type": "object", "properties": { "queries": { "$ref": "#/components/schemas/PaymentMethodsQueries" }, "filters": { "$ref": "#/components/schemas/PaymentMethodsFilters" } }, "required": [ "queries" ] }, "EligibilityOfferEntity": { "title": "EligibilityOfferEntity", "description": "Eligible offer object", "type": "object", "properties": { "eligibility": { "type": "boolean", "example": true }, "entity_type": { "type": "string", "example": "offers" }, "entity_value": { "type": "string", "example": "d2b430fb-1afe-455a-af31-66d00377b29a" }, "entity_details": { "allOf": [ { "$ref": "#/components/schemas/OfferEntity" } ], "example": { "$ref": "#/components/examples/offer_entity_example/value/0" } } } }, "EligibilityPaylaterEntity": { "title": "EligibilityPaylaterEntity", "description": "Eligible paylater payment method", "type": "object", "properties": { "eligibility": { "type": "boolean", "example": true }, "entity_type": { "type": "string", "example": "paylater" }, "entity_value": { "type": "string", "example": "olapostpaid" }, "entity_details": { "allOf": [ { "$ref": "#/components/schemas/PaylaterEntity" } ], "example": { "payment_method": { "type": "string", "example": "olapostpaid" } } } } }, "EligibilityPaymentMethodsEntity": { "title": "EligibilityPaymentMethodsEntity", "description": "Eligible payment methods details", "type": "object", "properties": { "eligibility": { "type": "boolean", "example": true }, "entity_type": { "type": "string", "example": "payment_methods" }, "entity_value": { "type": "string", "example": "netbanking" }, "entity_details": { "type": "object", "properties": { "payment_method_details": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentModeDetails" } } }, "example": { "payment_method_details": [ { "nick": "motak_kahindra_bank", "display": "Motak Kahindra Bank", "eligibility": true, "code": 3032 }, { "nick": "bank_of_india", "display": "Bank Of India", "eligibility": true, "code": 3031 } ] } } } }, "InternationalPaymentEntity": { "title": "InternationalPayment", "description": "International payment details", "type": "object", "properties": { "international": { "type": "boolean" } } }, "ErrorDetailsInPaymentsEntity": { "title": "ErrorDetailsInPayments", "description": "The error details are present only for failed payments", "example": { "error_code": "TRANSACTION_DECLINED", "error_description": "issuer bank or payment service provider declined the transaction", "error_reason": "auth_declined", "error_source": "customer", "error_code_raw": "ZM", "error_description_raw": "INVALID / INCORRECT MPIN", "error_subcode_raw": "" }, "type": "object", "properties": { "error_code": { "type": "string" }, "error_description": { "type": "string" }, "error_reason": { "type": "string" }, "error_source": { "type": "string" }, "error_code_raw": { "type": "string" }, "error_description_raw": { "type": "string" }, "error_subcode_raw": { "type": "string" } } }, "FetchReconRequest": { "type": "object", "description": "Recon object", "example": { "pagination": { "limit": 10, "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==" }, "filters": { "start_date": "2022-07-20T00:00:00Z", "end_date": "2022-07-21T23:59:59Z" } }, "properties": { "pagination": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of settlements you want to fetch in the next iteration. Maximum limit is 1000, default value is 10." }, "cursor": { "type": "string", "description": "Specifies from where the next set of settlement details should be fetched." } }, "description": "To fetch the next set of settlements, pass the cursor received in the response to the next API call. \n To receive the data for the first time, pass the cursor as null. \n Limit would be number of settlements that you want to receive.", "required": [ "limit" ] }, "filters": { "type": "object", "properties": { "start_date": { "type": "string", "description": "Specify the start date from when you want the settlement reconciliation details." }, "end_date": { "type": "string", "description": "Specify the end date till when you want the settlement reconciliation details." } }, "required": [ "start_date", "end_date" ] } }, "required": [ "pagination", "filters" ] }, "FetchSettlementsRequest": { "type": "object", "description": "Request to fetch settlement", "example": { "pagination": { "limit": 10, "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==" }, "filters": { "cf_settlement_ids": [ "4234233" ], "settlement_utrs": [ "utr1", "utr2" ], "start_date": "2022-07-20T00:00:00Z", "end_date": "2022-07-21T23:59:59Z" } }, "properties": { "pagination": { "type": "object", "properties": { "limit": { "type": "integer", "description": "The number of settlements you want to fetch. Maximum limit is 1000, default value is 10." }, "cursor": { "type": "string", "description": "Specifies from where the next set of settlement details should be fetched." } }, "description": "To fetch the next set of settlements, pass the cursor received in the response to the next API call. \n To receive the data for the first time, pass the cursor as null. \n Limit would be number of settlements that you want to receive.", "required": [ "limit" ] }, "filters": { "type": "object", "properties": { "cf_settlement_ids": { "type": "array", "items": { "type": "string" }, "description": "List of settlement IDs for which you want the settlement reconciliation details." }, "settlement_utrs": { "type": "array", "items": { "type": "string" }, "description": "List of settlement UTRs for which you want the settlement reconciliation details." }, "start_date": { "type": "string", "description": "Specify the start date from when you want the settlement reconciliation details." }, "end_date": { "type": "string", "description": "Specify the end date till when you want the settlement reconciliation details." } }, "description": "Specify either the Settlement ID, Settlement UTR, or start date and end date to fetch the settlement details." } }, "required": [ "pagination", "filters" ] }, "FetchTerminalQRCodesEntity": { "title": "FetchTerminalQRCodesEntity", "description": "Fetch Static QR Codes using terminal ID or phone number", "example": { "bank": "SIM", "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///", "qrCodeUrl": "upi://pay?cu=INR&pa=cf.vpa-epos-gamma202601415xwtvf9", "status": "ACTIVE" }, "type": "object", "properties": { "bank": { "type": "string", "description": "Name of the bank that is linked to the Static QR." }, "qrCode": { "type": "string", "description": "Base-64 Encoded QR Code URL" }, "qrCodeUrl": { "type": "string", "description": "URL of the qr Code." }, "status": { "type": "string", "description": "Status of the static QR." } } }, "IdempotencyError": { "title": "IdempotencyError", "description": "Error when idempotency fails. Different request body with the same idempotent key", "example": { "message": "something is not found", "code": "request_invalid", "type": "idempotency_error" }, "type": "object", "properties": { "message": { "type": "string" }, "help": { "type": "string" }, "code": { "type": "string" }, "type": { "type": "string", "enum": [ "idempotency_error" ], "description": "idempotency_error" } } }, "InstrumentEntity": { "title": "InstrumentEntity", "description": "Saved card instrument object", "example": { "customer_id": "siddhesh_desai", "afa_reference": "740324562", "instrument_id": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10", "instrument_type": "card", "instrument_uid": "0d8f70838cc5af8b1cd2bc0fe71278551fd3f1101e40020d89ad22ceba4f933c", "instrument_display": "xxxxxxxxxxxx4375", "instrument_status": "ACTIVE", "created_at": "2021-11-11 16:57:57", "instrument_meta": { "card_network": "VISA", "card_bank_name": "HDFC Bank Limited", "card_country": "IN", "card_type": "DEBIT_CARD", "card_token_details": { "par": "somepar", "expiry_month": "12", "expiry_year": "23" } } }, "properties": { "customer_id": { "type": "string", "description": "customer_id for which the instrument was saved" }, "afa_reference": { "type": "string", "description": "cf_payment_id of the successful transaction done while saving instrument" }, "instrument_id": { "type": "string", "description": "saved instrument id" }, "instrument_type": { "type": "string", "enum": [ "card" ], "description": "Type of the saved instrument" }, "instrument_uid": { "type": "string", "description": "Unique id for the saved instrument" }, "instrument_display": { "type": "string", "description": "masked card number displayed to the customer" }, "instrument_status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE" ], "description": "Status of the saved instrument." }, "created_at": { "type": "string", "description": "Timestamp at which instrument was saved." }, "instrument_meta": { "$ref": "#/components/schemas/SavedInstrumentMeta" } } }, "InstrumentWebhook": { "title": "InstrumentWebhook", "description": "Instrument webhook object", "type": "object", "properties": { "data": { "type": "object", "properties": { "data": { "type": "object", "title": "InstrumentWebhookDataEntity", "description": "data entity in webhook", "properties": { "instrument": { "allOf": [ { "$ref": "#/components/schemas/InstrumentEntity" } ] } } }, "event_time": { "type": "string", "example": "2021-10-07T19:42:44+05:30" }, "type": { "type": "string", "example": "INSTRUMENT_ACTIVE_WEBHOOK" } } } } }, "PaymentWebhook": { "title": "PaymentWebhook", "description": "payment webhook object", "type": "object", "properties": { "data": { "type": "object", "title": "PaymentWebhookDataEntity", "description": "data entity in webhook", "properties": { "order": { "type": "object", "title": "PaymentWebhookOrderEntity", "description": "order entity in webhook", "properties": { "order_id": { "type": "string" }, "order_amount": { "type": "number", "format": "double" }, "order_currency": { "type": "string" }, "order_tags": { "type": "object", "maxProperties": 15, "description": "Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } } } }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentEntity" } ] }, "customer_details": { "type": "object", "description": "customer details object in webhook", "title": "PaymentWebhookCustomerEntity", "properties": { "customer_name": { "type": "string", "example": "Yogesh" }, "customer_id": { "type": "string", "example": "12121212" }, "customer_email": { "type": "string", "example": "yogesh.miglani@gmail.com" }, "customer_phone": { "type": "string", "example": "9666699999" } } }, "error_details": { "type": "object", "description": "error details present in the webhook", "title": "PaymentWebhookErrorEntity", "properties": { "error_code": { "type": "string" }, "error_description": { "type": "string" }, "error_reason": { "type": "string" }, "error_source": { "type": "string" }, "error_code_raw": { "type": "string" }, "error_description_raw": { "type": "string" } } }, "payment_gateway_details": { "type": "object", "description": "payment gateway details present in the webhook response", "title": "PaymentWebhookGatewayDetailsEntity", "properties": { "gateway_name": { "type": "string" }, "gateway_order_id": { "type": "string" }, "gateway_order_reference_id": { "type": "string" }, "gateway_payment_id": { "type": "string" }, "gateway_status_code": { "type": "string" }, "gateway_settlement": { "type": "string" }, "gateway_reference_name": { "type": "string" } } }, "payment_offers": { "type": "array", "items": { "$ref": "#/components/schemas/OfferEntity" } } } }, "event_time": { "type": "string", "example": "2021-10-07T19:42:44+05:30" }, "type": { "type": "string", "example": "PAYMENT_SUCCESS_WEBHOOK" } } }, "RefundWebhook": { "title": "RefundWebhook", "description": "refund webhook object", "type": "object", "properties": { "data": { "type": "object", "title": "RefundWebhookDataEntity", "description": "data entity in webhook", "properties": { "refund": { "allOf": [ { "$ref": "#/components/schemas/RefundEntity" } ] } } }, "event_time": { "type": "string", "example": "2021-10-07T19:42:44+05:30" }, "type": { "type": "string", "example": "REFUND_SUCCESS_WEBHOOK" } } }, "EntitySimulationRequest": { "title": "entity_simulation", "description": "Entity Simulation it contains payment_status and payment_error_code", "type": "object", "example": { "payment_status": "FAILED", "payment_error_code": "ISSUER_NOT_AVAILABLE" }, "properties": { "payment_status": { "type": "string", "enum": [ "SUCCESS", "FAILED", "PENDING", "USER_DROPPED" ], "description": "Payment Status" }, "payment_error_code": { "type": "string", "description": "Payment Error Code" } }, "required": [ "payment_status" ] }, "EntitySimulationResponse": { "title": "entity_simulation", "description": "Entity Simulation it contains payment_status and payment_error_code", "type": "object", "example": { "payment_status": "FAILED", "payment_error_code": "ISSUER_NOT_AVAILABLE" }, "properties": { "payment_status": { "type": "string", "description": "Payment Status" }, "payment_error_code": { "type": "string", "description": "Payment Error Code" } }, "required": [ "payment_status" ] }, "LinkCustomerDetailsEntity": { "title": "customer_details", "description": "Payment link customer entity", "type": "object", "example": { "customer_name": "John Doe", "customer_phone": "9999999999", "customer_email": "john@cashfree.com", "customer_bank_account_number": 11111111111, "customer_bank_ifsc": "SBIN0001882", "customer_bank_code": 7001 }, "properties": { "customer_phone": { "type": "string", "description": "Customer phone number" }, "customer_email": { "type": "string", "description": "Customer email address" }, "customer_name": { "type": "string", "description": "Customer name" }, "customer_bank_account_number": { "type": "string", "description": "Customer Bank Account Number" }, "customer_bank_ifsc": { "type": "string", "description": "Customer Bank Ifsc" }, "customer_bank_code": { "type": "integer", "enum": [ 3003, 3005, 3006, 3010, 3012, 3016, 3019, 3020, 3021, 3022, 3023, 3024, 3026, 3027, 3028, 3029, 3030, 3031, 3032, 3033, 3038, 3039, 3040, 3042, 3044, 3054, 3055, 3058, 3086, 3087, 3088, 3089, 3090, 3091, 3092, 3098, 3115, 3117, 7001 ], "description": "Customer Bank Code" } }, "required": [ "customer_phone" ] }, "LinkEntity": { "title": "LinkEntity", "description": "Payment link success creation response object", "type": "object", "example": { "cf_link_id": "1996567", "link_id": "my_link_id", "link_status": "ACTIVE", "link_currency": "INR", "link_amount": 100, "link_amount_paid": 0, "link_partial_payments": true, "link_minimum_partial_amount": 20, "link_purpose": "Payment for PlayStation 11", "link_created_at": "2021-09-30T17:05:01+05:30", "customer_details": { "customer_name": "John Doe", "customer_phone": "9999999999", "customer_email": "john@example.com" }, "link_meta": { "notify_url": "https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net", "upi_intent": false, "return_url": "https://www.cashfree.com/devstudio/thankyou" }, "link_url": "https://payments-test.cashfree.com/links/o1tf1nvcvjhg", "link_expiry_time": "2021-10-14T15:04:05+05:30", "link_notes": { "key_1": "value_1", "key_2": "value_2" }, "link_auto_reminders": true, "link_qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAABlBMVEX///8AAABVwtN+AAAC9ElEQVR4nOyaPY7jMAyFn6HCpY7go/hmkXIzH0VHUOlC8Fvw0c4kM4PFFltJJjDAQPnSEPx5JIPbbrvttv9rC82mPW7gvnDasT5ZkSZyS/ZR6xLMANaJFQLJuj5J5mkHHgaMDpJlNfeROzAZFE4/PgKZOwZfoWTggchsDrvBd7DNZeW/+LEHUDmzY7Wn1aNHORO335JrNPBVcVPYl+2Y6/pssSS9/F6aOwDdLq9smLkBsUCl9aeNB6riymMzNwujI9QlW11hw/Lmx47AJVNBY16Zi71Ydy1JFTXU4UEGlvWYSfsGgbghXOn2HkGdgcCymdJS9GCu66HXmVtqsQwOvoSo/tnswbovLZ6mFpnHBpccTLHaPGMq5QBWKznZOpN9PbUeQcCdUV1mmFfkHmqcI4nBweZt2Ifc031SbEifrbgnMClndg8aWknJ1l5cpLlgHRp0OaZ5xiY4qRQPI5Our3mmO7Cs3L37mhp1SaYBNtRP9wwJnsll84zWYTmwJO5qOCV1CdpoT9pQkkykWWuResdccY22A4NIZIGmF2i4qesRXLBbcpWvNtwTuDCc7SWf0tTay6LVZ3ovpKOClkYHbHrZsU575LOddfiBD2XfFdhMhJozgo31NsXBFem35BoSlPjY9LkJdswkWywJEmmfWdgPeMqt64akQtr0Gj8XgKOCvubxjehmfszXaD992wH0AyL5BGZ9xqIHkU+eihRX9xkX9C2fSzKVFJtXouSITitvS8AhwSzBLm2mM6RmGoDaJfMtHvsC1YavzbD344pXxR0eNG1m8jx5yVHFNT9GBU/uEnSzDMnNSq8KLaATG0L9OiyOCfoFUn5sM7fj2gy/ztLoEtS12f6yqshc8Qj13AKFd202KHheIF2bQWseFkxKrrp8/6VLV+Au8cFNqYJYkrXZZ4s/f98zJEiPFd3gU9PPdij1/rEO6whUzsxnmug24gez6DkzOPiquAg+ztEX57rK1+WX0twBeNttt932d/sTAAD//zUdVfZhwUvzAAAAAElFTkSuQmCC", "link_notify": { "send_sms": false, "send_email": true }, "order_splits": [ { "vendor_id": "Jane", "percentage": 10, "tags": { "address": "Hyderabad" } }, { "vendor_id": "Barbie", "percentage": 50, "tags": { "address": "Bengaluru, India" } } ] }, "properties": { "cf_link_id": { "type": "string" }, "link_id": { "type": "string" }, "link_status": { "type": "string" }, "link_currency": { "type": "string" }, "link_amount": { "type": "number" }, "link_amount_paid": { "type": "number" }, "link_partial_payments": { "type": "boolean" }, "link_minimum_partial_amount": { "type": "number" }, "link_purpose": { "type": "string" }, "link_created_at": { "type": "string" }, "customer_details": { "$ref": "#/components/schemas/LinkCustomerDetailsEntity" }, "link_meta": { "$ref": "#/components/schemas/LinkMetaResponseEntity" }, "link_url": { "type": "string" }, "link_expiry_time": { "type": "string" }, "link_notes": { "$ref": "#/components/schemas/LinkNotesEntity" }, "link_auto_reminders": { "type": "boolean" }, "link_notify": { "$ref": "#/components/schemas/LinkNotifyEntity" }, "link_qrcode": { "type": "string", "description": "Base64 encoded string for payment link. You can scan with camera to open a link in the browser to complete the payment." }, "order_splits": { "type": "array", "items": { "$ref": "#/components/schemas/VendorSplit" } } } }, "LinkMetaResponseEntity": { "title": "link_meta", "description": "Payment link meta information object", "type": "object", "example": { "notify_url": "https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net", "upi_intent": "false", "return_url": "https://www.cashfree.com/devstudio/thankyou" }, "properties": { "notify_url": { "type": "string", "description": "Notification URL for server-server communication. It should be an https URL." }, "upi_intent": { "type": "string", "description": "If \"true\", link will directly open UPI Intent flow on mobile, and normal link flow elsewhere" }, "return_url": { "type": "string", "description": "The URL to which user will be redirected to after the payment is done on the link. Maximum length: 250." }, "payment_methods": { "type": "string", "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" } } }, "OfferDetailsResponse": { "description": "Offer details response and type", "example": { "cashback_details": { "cashback_type": "percentage", "cashback_value": "20", "max_cashback_amount": "150" }, "discount_details": { "discount_type": "flat", "discount_value": "10", "max_discount_amount": "10" }, "offer_type": "DISCOUNT_AND_CASHBACK" }, "properties": { "cashback_details": { "$ref": "#/components/schemas/CashbackDetails" }, "discount_details": { "$ref": "#/components/schemas/DiscountDetails" }, "offer_type": { "description": "Offer Type for the Offer.", "enum": [ "DISCOUNT", "CASHBACK", "DISCOUNT_AND_CASHBACK", "NO_COST_EMI" ], "example": "DISCOUNT_AND_CASHBACK", "maxLength": 50, "minLength": 3, "type": "string" } }, "title": "OfferDetailsResponse", "type": "object" }, "LinkNotesEntity": { "title": "link_notes", "type": "object", "description": "Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs", "example": { "key_1": "value_1", "key_2": "value_2" }, "additionalProperties": { "type": "string" } }, "LinkNotifyEntity": { "title": "link_notify", "type": "object", "description": "Payment link Notify Object for SMS and Email", "example": { "send_sms": false, "send_email": true }, "properties": { "send_sms": { "type": "boolean", "description": "If \"true\", Cashfree will send sms on customer_phone" }, "send_email": { "type": "boolean", "description": "If \"true\", Cashfree will send email on customer_email" } } }, "MethodsType": { "title": "MethodsType", "type": "string", "description": "Methods Type Object" }, "NetBankingPaymentMethod": { "title": "NetBankingPaymentMethod", "description": "Payment method for netbanking object", "example": { "netbanking": { "channel": "link", "netbanking_bank_code": 3022 } }, "type": "object", "properties": { "netbanking": { "$ref": "#/components/schemas/Netbanking" } }, "required": [ "netbanking" ] }, "Netbanking": { "title": "Netbanking", "description": "Netbanking payment method request body", "example": { "channel": "link", "netbanking_bank_code": 3022 }, "type": "object", "properties": { "channel": { "type": "string", "description": "The channel for netbanking will always be `link`" }, "netbanking_bank_code": { "type": "integer", "format": "int32", "description": "Bank code", "pattern": "^\\d{4}$" }, "netbanking_bank_name": { "type": "string", "format": "BANKR", "description": "String code for bank", "pattern": "^[A-Z]{5}$" } }, "required": [ "channel" ] }, "OfferAll": { "title": "All Offers", "description": "returns all offers", "example": { "all": {} }, "type": "object", "properties": { "all": { "$ref": "#/components/schemas/AllOffers" } }, "required": [ "all" ] }, "OfferCard": { "title": "Card Offer", "description": "Offers related to cards", "example": { "card": { "type": [ "cc" ], "bank_name": "hdfc bank", "scheme_name": [ "visa" ] } }, "type": "object", "properties": { "card": { "title": "Card Offer", "type": "object", "properties": { "type": { "type": "array", "items": { "$ref": "#/components/schemas/CardArray" } }, "bank_name": { "type": "string", "description": "Bank Name of Card.", "minLength": 3, "maxLength": 100, "example": "hdfc bank" }, "scheme_name": { "type": "array", "items": { "$ref": "#/components/schemas/SchemeArray" } } }, "required": [ "type", "bank_name", "scheme_name" ] } }, "required": [ "card" ] }, "OfferDetails": { "title": "OfferDetails", "description": "Offer details and type", "type": "object", "example": { "offer_type": "DISCOUNT_AND_CASHBACK", "discount_details": { "discount_type": "flat", "discount_value": "10", "max_discount_amount": "10" }, "cashback_details": { "cashback_type": "percentage", "cashback_value": "20", "max_cashback_amount": "150" } }, "properties": { "offer_type": { "type": "string", "description": "Offer Type for the Offer.", "enum": [ "DISCOUNT", "CASHBACK", "DISCOUNT_AND_CASHBACK", "NO_COST_EMI" ], "minLength": 3, "maxLength": 50, "example": "DISCOUNT_AND_CASHBACK" }, "discount_details": { "$ref": "#/components/schemas/DiscountDetails" }, "cashback_details": { "$ref": "#/components/schemas/CashbackDetails" } }, "required": [ "offer_type" ] }, "OfferEMI": { "title": "EMI Offer", "description": "EMI offer object", "type": "object", "example": { "emi": { "type": "cardless_emi", "issuer": "hdfc bank", "tenures": [ 3, 6 ] } }, "properties": { "emi": { "title": "EMI Offer", "type": "object", "properties": { "type": { "type": "string", "description": "Type of emi offer. Possible values are `credit_card_emi`, `debit_card_emi`, `cardless_emi`", "minLength": 3, "maxLength": 100, "example": "cardless_emi" }, "issuer": { "type": "string", "description": "Bank Name", "minLength": 3, "maxLength": 100, "example": "hdfc bank" }, "tenures": { "type": "array", "items": { "title": "Tenure Array", "type": "integer", "example": 3 } } }, "required": [ "type", "issuer", "tenures" ] } }, "required": [ "emi" ] }, "OfferEntity": { "title": "OfferEntity", "type": "object", "description": "Offer entity object", "properties": { "offer_id": { "type": "string", "example": "d2b430fb-1afe-455a-af31-66d00377b29a" }, "offer_status": { "type": "string", "example": "active" }, "order_amount": { "type": "number", "format": "float64" }, "payable_amount": { "type": "number", "format": "float64" }, "offer_meta": { "allOf": [ { "$ref": "#/components/schemas/OfferMetaResponse" } ], "example": { "$ref": "#/components/schemas/OfferMetaResponse/example" } }, "offer_tnc": { "allOf": [ { "$ref": "#/components/schemas/OfferTncResponse" } ], "example": { "$ref": "#/components/schemas/OfferTncResponse/example" } }, "offer_details": { "allOf": [ { "$ref": "#/components/schemas/OfferDetailsResponse" } ], "example": { "$ref": "#/components/schemas/OfferDetailsResponse/example" } }, "offer_validations": { "allOf": [ { "$ref": "#/components/schemas/OfferValidationsResponse" } ], "example": { "$ref": "#/components/schemas/OfferValidationsResponse/example" } } } }, "OfferValidationsResponse": { "description": "Offer validation object", "example": { "max_allowed": 2, "min_amount": 10, "payment_method": { "wallet": { "issuer": "paytm" } } }, "properties": { "max_allowed": { "description": "Maximum Amount for Offer to be Applicable", "example": 1, "minimum": 1, "type": "number" }, "min_amount": { "description": "Minimum Amount for Offer to be Applicable", "example": 1, "minimum": 1, "type": "number" }, "payment_method": { "example": { "wallet": { "issuer": "paytm" } }, "oneOf": [ { "$ref": "#/components/schemas/OfferAll" }, { "$ref": "#/components/schemas/OfferCard" }, { "$ref": "#/components/schemas/OfferNB" }, { "$ref": "#/components/schemas/OfferWallet" }, { "$ref": "#/components/schemas/OfferUPI" }, { "$ref": "#/components/schemas/OfferPaylater" }, { "$ref": "#/components/schemas/OfferEMI" } ] } }, "title": "OfferValidationsResponse", "type": "object" }, "OfferTncResponse": { "description": "Offer terms and condition object", "example": { "offer_tnc_type": "text", "offer_tnc_value": "TnC for the Offer." }, "properties": { "offer_tnc_type": { "description": "TnC Type for the Offer. It can be either `text` or `link`", "enum": [ "text", "link" ], "example": "text", "maxLength": 50, "minLength": 3, "type": "string" }, "offer_tnc_value": { "description": "TnC for the Offer.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit", "maxLength": 100, "minLength": 3, "type": "string" } }, "title": "OfferTncResponse", "type": "object" }, "OfferMetaResponse": { "description": "Offer meta response details object", "example": { "offer_code": "CFTESTOFFER", "offer_description": "some offer description", "offer_end_time": "2023-03-29T08:09:51Z", "offer_start_time": "2023-03-21T08:09:51Z", "offer_title": "some title" }, "properties": { "offer_code": { "description": "Unique identifier for the Offer.", "example": "CFTESTOFFER", "maxLength": 45, "minLength": 1, "type": "string" }, "offer_description": { "description": "Description for the Offer.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit", "maxLength": 100, "minLength": 3, "type": "string" }, "offer_end_time": { "description": "Expiry Time for the Offer", "example": "2023-03-29T08:09:51Z", "type": "string" }, "offer_start_time": { "description": "Start Time for the Offer", "example": "2023-03-21T08:09:51Z", "maxLength": 20, "minLength": 3, "type": "string" }, "offer_title": { "description": "Title for the Offer.", "example": "Test Offer", "maxLength": 50, "minLength": 3, "type": "string" } }, "title": "OfferMetaResponse", "type": "object" }, "OfferFilters": { "title": "OfferFilters", "type": "object", "description": "Filter for offers", "properties": { "offer_type": { "type": "array", "description": "Array of offer_type to be filtered.", "items": { "$ref": "#/components/schemas/OfferType" } } }, "example": { "offer_type": [ "DISCOUNT_AND_CASHBACK", "DISCOUNT" ] } }, "OfferMeta": { "title": "OfferMeta", "type": "object", "description": "Offer meta details object", "example": { "offer_title": "some title", "offer_description": "some offer description", "offer_code": "CFTESTOFFER", "offer_start_time": "2023-03-21T08:09:51Z", "offer_end_time": "2023-03-29T08:09:51Z" }, "properties": { "offer_title": { "type": "string", "description": "Title for the Offer.", "minLength": 3, "maxLength": 50, "example": "Test Offer" }, "offer_description": { "type": "string", "description": "Description for the Offer.", "minLength": 3, "maxLength": 100, "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit" }, "offer_code": { "type": "string", "description": "Unique identifier for the Offer.", "minLength": 1, "maxLength": 45, "example": "CFTESTOFFER" }, "offer_start_time": { "type": "string", "description": "Start Time for the Offer", "minLength": 3, "maxLength": 20, "example": "2023-03-21T08:09:51Z" }, "offer_end_time": { "type": "string", "description": "Expiry Time for the Offer", "example": "2023-03-29T08:09:51Z" } }, "required": [ "offer_title", "offer_description", "offer_code", "offer_start_time", "offer_end_time" ] }, "OfferNB": { "title": "Net Banking Offer", "description": "Offer object ofr NetBanking", "example": { "netbanking": { "bank_name": "hdfc bank" } }, "type": "object", "properties": { "netbanking": { "type": "object", "properties": { "bank_name": { "type": "string", "example": "all" } } } }, "required": [ "netbanking" ] }, "OfferPaylater": { "title": "Paylater Offer", "description": "Offer object for paylater", "example": { "paylater": { "issuer": "lazypay" } }, "type": "object", "properties": { "paylater": { "title": "Paylater Offer", "type": "object", "properties": { "provider": { "type": "string", "example": "simpl" } } } }, "required": [ "paylater" ] }, "OfferQueries": { "title": "OfferQueries", "description": "Offer Query Object", "type": "object", "example": { "order_id": "order_413462PK1RI1IwYB1X69LgzUQWiSxYDF", "amount": 100 }, "properties": { "order_id": { "type": "string", "description": "OrderId of the order. Either of `order_id` or `order_amount` is mandatory.", "minLength": 3, "maxLength": 50, "format": "string", "example": "order_413462PK1RI1IwYB1X69LgzUQWiSxYDF" }, "amount": { "type": "number", "description": "Amount of the order. OrderId of the order. Either of `order_id` or `order_amount` is mandatory.", "minimum": 1, "example": 100 } } }, "OfferTnc": { "title": "OfferMeta", "type": "object", "description": "Offer terms and condition object", "example": { "offer_tnc_type": "text", "offer_tnc_value": "TnC for the Offer." }, "properties": { "offer_tnc_type": { "type": "string", "description": "TnC Type for the Offer. It can be either `text` or `link`", "enum": [ "text", "link" ], "minLength": 3, "maxLength": 50, "example": "text" }, "offer_tnc_value": { "type": "string", "description": "TnC for the Offer.", "minLength": 3, "maxLength": 100, "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit" } }, "required": [ "offer_tnc_type", "offer_tnc_value" ] }, "OfferType": { "title": "OfferType", "type": "string", "description": "Offer Type Object", "example": "DISCOUNT_AND_CASHBACK", "enum": [ "DISCOUNT", "CASHBACK", "DISCOUNT_AND_CASHBACK", "NO_COST_EMI" ] }, "OfferUPI": { "title": "UPI Offer", "description": "Offer object for UPI", "example": { "upi": {} }, "type": "object", "properties": { "upi": { "title": "UPI Offer", "type": "object" } }, "required": [ "upi" ] }, "OfferValidations": { "title": "OfferValidations", "description": "Offer validation object", "type": "object", "example": { "min_amount": 10, "payment_method": { "wallet": { "issuer": "paytm" } }, "max_allowed": 2 }, "properties": { "min_amount": { "type": "number", "description": "Minimum Amount for Offer to be Applicable", "minimum": 1, "example": 1 }, "max_allowed": { "type": "number", "description": "Maximum Amount for Offer to be Applicable", "minimum": 1, "example": 1 }, "payment_method": { "example": { "wallet": { "issuer": "paytm" } }, "oneOf": [ { "$ref": "#/components/schemas/OfferAll" }, { "$ref": "#/components/schemas/OfferCard" }, { "$ref": "#/components/schemas/OfferNB" }, { "$ref": "#/components/schemas/OfferWallet" }, { "$ref": "#/components/schemas/OfferUPI" }, { "$ref": "#/components/schemas/OfferPaylater" }, { "$ref": "#/components/schemas/OfferEMI" } ] } }, "required": [ "max_allowed", "payment_method" ] }, "OfferWallet": { "title": "Wallet Offer", "description": "Offer object for wallet payment method", "example": { "app": { "issuer": "paytm" } }, "type": "object", "properties": { "app": { "title": "Wallet Offer", "type": "object", "properties": { "provider": { "type": "string", "example": "paytm" } } } }, "required": [ "app" ] }, "OrderAuthenticateEntity": { "title": "OrderAuthenticateEntity", "description": "This is the response shared when merchant inovkes the OTP submit or resend API", "example": { "cf_payment_id": "975654863", "authenticate_status": "FAILED", "action": "SUBMIT_OTP", "payment_message": "otp is invalid" }, "properties": { "cf_payment_id": { "type": "string", "description": "The Payment ID for which this request was sent" }, "action": { "type": "string", "enum": [ "SUBMIT_OTP", "RESEND_OTP" ], "description": "The action that was invoked for this request." }, "authenticate_status": { "type": "string", "enum": [ "FAILED", "SUCCESS" ], "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." }, "payment_message": { "type": "string", "description": "Human readable message which describes the status in more detail" } } }, "OrderAuthenticatePaymentRequest": { "title": "OrderAuthenticatePaymentRequest", "description": "OTP to be submitted for headless/native OTP", "type": "object", "required": [ "otp", "action" ], "properties": { "otp": { "type": "string", "description": "OTP to be submitted" }, "action": { "type": "string", "enum": [ "SUBMIT_OTP", "RESEND_OTP" ], "description": "The action for this workflow. Could be either SUBMIT_OTP or RESEND_OTP" } }, "example": { "otp": "111000", "action": "SUBMIT_OTP" } }, "OrderCreateRefundRequest": { "title": "OrderCreateRefundRequest", "description": "create refund request object", "example": { "refund_amount": 1, "refund_id": "refund_00912", "refund_note": "refund note for reference", "refund_speed": "STANDARD" }, "type": "object", "properties": { "refund_amount": { "type": "number", "format": "double", "description": "Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed)" }, "refund_id": { "type": "string", "description": "An unique ID to associate the refund with. Provie alphanumeric values", "minLength": 3, "maxLength": 40 }, "refund_note": { "type": "string", "description": "A refund note for your reference.", "minLength": 3, "maxLength": 100 }, "refund_speed": { "type": "string", "enum": [ "STANDARD", "INSTANT" ], "description": "Speed at which the refund is processed. It's an optional field with default being STANDARD" }, "refund_splits": { "type": "array", "items": { "$ref": "#/components/schemas/VendorSplit" } } }, "required": [ "refund_amount", "refund_id" ] }, "OrderEntity": { "title": "OrderEntity", "type": "object", "description": "The complete order entity", "example": { "$ref": "#/components/examples/order_entity_list_example/value/0" }, "properties": { "cf_order_id": { "type": "string", "description": "unique id generated by cashfree for your order" }, "order_id": { "type": "string", "description": "order_id sent during the api request" }, "entity": { "type": "string", "description": "Type of the entity." }, "order_currency": { "type": "string", "description": "Currency of the order. Example INR" }, "order_amount": { "type": "number" }, "order_status": { "type": "string", "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" }, "payment_session_id": { "type": "string" }, "order_expiry_time": { "type": "string", "format": "date-time" }, "order_note": { "type": "string", "description": "Additional note for order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created at cashfree's server", "example": "2022-08-16T14:45:38+05:30" }, "order_splits": { "type": "array", "items": { "$ref": "#/components/schemas/VendorSplit" } }, "customer_details": { "$ref": "#/components/schemas/CustomerDetailsResponse" }, "order_meta": { "$ref": "#/components/schemas/OrderMeta" }, "order_tags": { "$ref": "#/components/schemas/OrderTags" }, "cart_details": { "$ref": "#/components/schemas/CartDetailsEntity" }, "terminal_data": { "$ref": "#/components/schemas/TerminalData" }, "products": { "type": "object", "description": "Configurations for the products like One Click Checkout, Verify and Pay, if they are enabled for your account", "properties": { "one_click_checkout": { "$ref": "#/components/schemas/ProductDetailsEntity" }, "verify_pay": { "$ref": "#/components/schemas/ProductDetailsEntity" } } } } }, "OrderExtendedDataEntity": { "title": "OrderExtendedDataEntity", "type": "object", "description": "The complete order extended data entity", "example": { "$ref": "#/components/examples/order_extended_data_entity_list_example/value/0" }, "properties": { "cf_order_id": { "type": "string", "description": "unique id generated by cashfree for your order" }, "order_id": { "type": "string", "description": "order_id sent during the api request" }, "order_amount": { "type": "number" }, "order_currency": { "type": "string", "description": "Currency of the order. Example INR" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created at cashfree's server", "example": "2022-08-16T14:45:38+05:30" }, "charges": { "$ref": "#/components/schemas/ChargesEntity" }, "customer_details": { "$ref": "#/components/schemas/ExtendedCustomerDetails" }, "shipping_address": { "$ref": "#/components/schemas/AddressDetails" }, "billing_address": { "$ref": "#/components/schemas/AddressDetails" }, "cart": { "$ref": "#/components/schemas/ExtendedCartDetails" }, "offer": { "$ref": "#/components/schemas/OfferExtendedDetails" } } }, "OfferExtendedDetails": { "title": "OfferEntity", "type": "object", "description": "Details of the offer which got applied to the paid order.", "properties": { "offer_id": { "type": "string", "example": "d2b430fb-1afe-455a-af31-66d00377b29a" }, "offer_status": { "type": "string", "example": "active" }, "offer_meta": { "allOf": [ { "$ref": "#/components/schemas/OfferMeta" } ], "example": { "$ref": "#/components/schemas/OfferMeta/example" } }, "offer_tnc": { "allOf": [ { "$ref": "#/components/schemas/OfferTnc" } ], "example": { "$ref": "#/components/schemas/OfferTnc/example" } }, "offer_details": { "allOf": [ { "$ref": "#/components/schemas/OfferDetails" } ], "example": { "$ref": "#/components/schemas/OfferDetails/example" } }, "offer_validations": { "allOf": [ { "$ref": "#/components/schemas/OfferValidations" } ], "example": { "$ref": "#/components/schemas/OfferValidations/example" } } } }, "ExtendedCartDetails": { "title": "CartDetails", "description": "The cart details that are necessary like shipping address, billing address and more.", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the cart." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CartItem" } } } }, "AddressDetails": { "title": "AddressDetails", "description": "Address associated with the customer.", "type": "object", "example": { "name": "Aditya Keshri", "address_line_one": "MK Building", "address_line_two": "Test Address", "country": "India", "country_code": "IN", "state": "Karnataka", "state_code": "KA", "city": "Bangalore", "pin_code": "560034", "phone": "+91 1118911189", "email": "test@cashfree.com" }, "properties": { "name": { "type": "string", "description": "Full Name of the customer associated with the address." }, "address_line_one": { "type": "string", "description": "First line of the address." }, "address_line_two": { "type": "string", "description": "Second line of the address." }, "country": { "type": "string", "description": "Country Name." }, "country_code": { "type": "string", "description": "Country Code." }, "state": { "type": "string", "description": "State Name." }, "state_code": { "type": "string", "description": "State Code." }, "city": { "type": "string", "description": "City Name." }, "pin_code": { "type": "string", "description": "Pin Code/Zip Code." }, "phone": { "type": "string", "description": "Customer Phone Number." }, "email": { "type": "string", "description": "Cutomer Email Address." } } }, "ChargesEntity": { "title": "ChargesEntity", "description": "Charges accociated with the order", "type": "object", "example": { "shipping_charges": 5, "cod_handling_charges": 10 }, "properties": { "shipping_charges": { "type": "number", "description": "Shipping charge of the order" }, "cod_handling_charges": { "type": "number", "description": "COD handling fee for order" } } }, "ExtendedCustomerDetails": { "title": "CustomerDetails", "description": "Recent Customer details associated with the order.", "example": { "customer_id": "7112AAA812234", "customer_email": "john@cashfree.com", "customer_phone": "9908734801", "customer_name": "John Doe", "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10" }, "type": "object", "properties": { "customer_id": { "type": "string", "description": "A unique identifier for the customer. Use alphanumeric values only.", "minLength": 3, "maxLength": 50 }, "customer_email": { "type": "string", "description": "Customer email address.", "minLength": 3, "maxLength": 100 }, "customer_phone": { "type": "string", "description": "Customer phone number.", "minLength": 10, "maxLength": 10 }, "customer_name": { "type": "string", "description": "Name of the customer.", "minLength": 3, "maxLength": 100 }, "customer_uid": { "type": "string", "description": "Customer identifier at Cashfree. You will get this when you create/get customer" } } }, "UpdateOrderExtendedDataEntity": { "title": "UpdateOrderExtendedDataEntity", "type": "object", "description": "The complete update order extended data entity", "example": { "$ref": "#/components/examples/update_order_extended_data_entity_list_example/value/0" }, "properties": { "cf_order_id": { "type": "string", "description": "unique id generated by cashfree for your order" }, "order_id": { "type": "string", "description": "order_id sent during the api request" }, "shipment_details": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDetails" } }, "order_delivery_status": { "$ref": "#/components/schemas/OrderDeliveryStatus" } } }, "CartDetailsEntity": { "title": "CartDetailsEntity", "description": "Cart Details in the Order Entity Response", "type": "object", "properties": { "cart_id": { "type": "string", "description": "ID of the cart that was created" } } }, "OrderMeta": { "title": "OrderMeta", "description": "Optional meta details to control how the customer pays and how payment journey completes", "type": "object", "properties": { "return_url": { "type": "string", "example": "https://www.cashfree.com/devstudio/thankyou", "description": "The URL to which user will be redirected to after the payment on bank OTP page. Maximum length: 250. We suggest to keep context of order_id in your return_url so that you can identify the order when customer lands on your page. Example of return_url format could be https://www.cashfree.com/devstudio/thankyou" }, "notify_url": { "type": "string", "example": "https://example.com/cf_notify", "description": "Notification URL for server-server communication. Useful when user's connection drops while re-directing. NotifyUrl should be an https URL. Maximum length: 250." }, "payment_methods": { "example": "cc,dc,upi", "description": "Allowed payment modes for this order. Pass comma-separated values among following options - \"cc\", \"dc\", \"ccc\", \"ppc\",\"nb\",\"upi\",\"paypal\",\"app\",\"paylater\",\"cardlessemi\",\"dcemi\",\"ccemi\",\"banktransfer\". Leave it blank to show all available payment methods" }, "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.", "type": "object", "properties": { "methods": { "description": "Allowed payment modes for this order. credit_card, debit_card, netbanking, paylater, etc are the values that can be passed to this parameter.", "type": "object", "properties": { "action": { "type": "string", "description": "It accepts value of \"ALLOW\" and allows only those modes present in it's neighbouring parameter \"values\"" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted entries for this paramter are \"debit_card, credit_card, prepaid_card, upi, wallet, netbanking, banktransfer, paylater, paypal, debit_card_emi, credit_card_emi, upi_credit_card, upi_ppi, cardless_emi, account_based_payment, corporate_credit_card, sbc_debit_card, sbc_emandate, sbc_upi, sbc_credit_card\"" } } }, "filters": { "description": "This object takes details of all the filtering that has to be done for this order. Filters on card bins, card schemes, card issuing bank and card suffixes", "type": "object", "properties": { "card_bins": { "description": "Allowed card bins for the order", "type": "object", "properties": { "action": { "type": "string", "description": "It accepts value of \"ALLOW\" and allows only those bins present in it's neighbouring parameter \"values\"" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of card bins to be allowed for the order" } } }, "card_schemes": { "description": "Allowed card schemes for the order", "type": "object", "properties": { "action": { "type": "string", "description": "It accepts value of \"ALLOW\" and allows only those schemes present in it's neighbouring parameter \"values\"" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of card schemes to be allowed for the order" } } }, "card_suffix": { "description": "Allowed card suffixes for the order", "type": "object", "properties": { "action": { "type": "string", "description": "It accepts value of \"ALLOW\" and allows only those suffixes present in it's neighbouring parameter \"values\"" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of card suffixes to be allowed for the order" } } }, "card_issuing_bank": { "description": "Allowed card issuing bank for the order", "type": "object", "properties": { "action": { "type": "string", "description": "It accepts value of \"ALLOW\" and allows only those issuing bank present in it's neighbouring parameter \"values\"" }, "values": { "type": "array", "description": "List of card issuing bank to be allowed for the order", "items": { "type": "string" } } } } } } } } } }, "OrderPayData": { "title": "OrderPayData", "type": "object", "description": "the data object pay api", "example": { "url": "https://examplebank.com/sendTo/897?q", "payload": { "MD": 89811231231, "PaReq": "89123l1j2l3j1ljkkl=" }, "content_type": "application/x-www-form-encoded", "method": "post", "redirect_to_bank": "https://sandbox.cashfree.com/pg/view/redirecttobank/tY-asY5v40gWHD2q4gXV553XmQHSYM5LNzBVrD1JtR_A682dcfHOKzb" }, "properties": { "url": { "type": "string" }, "payload": { "type": "object" }, "content_type": { "type": "string" }, "method": { "type": "string" }, "redirect_to_bank": { "type": "string" } } }, "OrderTags": { "type": "object", "maxProperties": 15, "description": "Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 }, "example": { "product": "Laptop", "shipping_address": "123 Main St" } }, "ProductDetailsEntity": { "type": "object", "description": "Configurations for this feature", "properties": { "enabled": { "type": "boolean", "description": "Whether the feature has been enabled for this order" }, "conditions": { "type": "array", "description": "Configured condtions for the feature", "items": { "$ref": "#/components/schemas/ProductConditionsEntity" } } } }, "ProductConditionsEntity": { "type": "object", "properties": { "action": { "type": "string", "description": "The Action key in the conditions array specifies whether a condition is allowed or denied for the specified rule or feature" }, "key": { "type": "string", "description": "key of the condition", "maxLength": 50 }, "values": { "type": "array", "description": "Values set for the condition", "maxItems": 10, "items": { "type": "string" } } } }, "ProductDetails": { "type": "object", "description": "Specify the required configurations for this feature", "properties": { "enabled": { "type": "boolean", "description": "Option to enable or disable the feature" }, "conditions": { "type": "array", "description": "The conditions array allows to configure rules by adding condition objects with specific parameters for feature configurations.", "items": { "$ref": "#/components/schemas/ProductConditions" } } } }, "ProductConditions": { "type": "object", "properties": { "action": { "type": "string", "description": "The Action key in the conditions array specifies whether a condition should \"ALLOW\" or \"DENY\" the specified rule or feature" }, "key": { "type": "string", "description": "Specify what you're trying to configure, such as \"features\"", "maxLength": 50 }, "values": { "type": "array", "description": "Define the values you need to set within the conditions in this array, such as \"checkoutCollectAddress\", \"checkoutAuthenticate\"", "maxItems": 10, "items": { "type": "string" } } } }, "PayOrderEntity": { "title": "PayOrderEntity", "type": "object", "description": "Order Pay response once you create a transaction for that order", "example": { "payment_method": "card", "channel": "link", "action": "link", "cf_payment_id": "91235", "payment_amount": 22.42, "data": { "url": "https://sandbox.cashfree.com/pg/view/gateway/FHsuvhayLM5mmhINoqri7ba296e2ebca8b98e6119f6223021a13", "payload": { "name": "card" }, "content_type": "application/x-www-form-urlencoded", "method": "post" } }, "properties": { "payment_amount": { "type": "number", "description": "total amount payable" }, "cf_payment_id": { "type": "string", "description": "Payment identifier created by Cashfree", "format": "int64" }, "payment_method": { "type": "string", "enum": [ "netbanking", "card", "upi", "app", "cardless_emi", "paylater", "banktransfer" ], "description": "One of [\"upi\", \"netbanking\", \"card\", \"app\", \"cardless_emi\", \"paylater\", \"banktransfer\"]" }, "channel": { "type": "string", "enum": [ "link", "collect", "qrcode", "post" ], "description": "One of [\"link\", \"collect\", \"qrcode\"]. In an older version we used to support different channels like 'gpay', 'phonepe' etc. However, we now support only the following channels - link, collect and qrcode. To process payments using gpay, you will have to provide channel as 'link' and provider as 'gpay'" }, "action": { "type": "string", "enum": [ "link", "custom", "form", "post" ], "description": "One of [\"link\", \"custom\", \"form\"]" }, "data": { "$ref": "#/components/schemas/OrderPayData" } } }, "PayOrderRequest": { "title": "PayOrderRequest", "type": "object", "description": "Complete object for the pay api that uses payment method objects", "properties": { "payment_session_id": { "type": "string", "example": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn" }, "payment_method": { "oneOf": [ { "$ref": "#/components/schemas/CardPaymentMethod" }, { "$ref": "#/components/schemas/UPIPaymentMethod" }, { "$ref": "#/components/schemas/NetBankingPaymentMethod" }, { "$ref": "#/components/schemas/AppPaymentMethod" }, { "$ref": "#/components/schemas/CardEMIPaymentMethod" }, { "$ref": "#/components/schemas/CardlessEMIPaymentMethod" }, { "$ref": "#/components/schemas/PaylaterPaymentMethod" }, { "$ref": "#/components/schemas/BanktransferPaymentMethod" } ] }, "save_instrument": { "type": "boolean" }, "offer_id": { "type": "string", "description": "This is required if any offers needs to be applied to the order.", "example": "faa6cc05-d1e2-401c-b0cf-0c9db3ff0f0b" }, "payment_surcharge": { "type": "object", "properties": { "payment_surcharge_service_charge": { "type": "number", "format": "float64" }, "payment_surcharge_service_tax": { "type": "number", "format": "float64" } } } }, "required": [ "payment_session_id", "payment_method" ] }, "Paylater": { "title": "Paylater", "description": "Paylater payment method", "example": { "channel": "link", "provider": "kotak", "phone": "7789112345" }, "type": "object", "properties": { "channel": { "type": "string", "description": "The channel for cardless EMI is always `link`" }, "provider": { "type": "string", "enum": [ "kotak", "flexipay", "zestmoney", "lazypay", "olapostpaid", "simpl", "freechargepaylater" ], "description": "One of [\"kotak\", \"flexipay\", \"zestmoney\", \"lazypay\", \"olapostpaid\",\"simpl\", \"freechargepaylater\"]. Please note that Flexipay is offered by HDFC bank" }, "phone": { "type": "string", "description": "Customers phone number for this payment instrument. If the customer is not eligible you will receive a 400 error with type as 'invalid_request_error' and code as 'invalid_request_error'" } } }, "Banktransfer": { "title": "Banktransfer", "description": "Banktransfer payment method", "example": { "channel": "link" }, "type": "object", "properties": { "channel": { "type": "string", "description": "The channel for cardless EMI is always `link`" } } }, "PaylaterEntity": { "title": "PaylaterEntity", "description": "Paylater Entity", "type": "object", "properties": { "payment_method": { "type": "string", "example": "olapostpaid" } } }, "PaylaterPaymentMethod": { "title": "PaylaterPaymentMethod", "description": "paylater payment method", "example": { "paylater": { "channel": "link", "phone": "781234121", "provider": "lazypay" } }, "type": "object", "properties": { "paylater": { "$ref": "#/components/schemas/Paylater" } }, "required": [ "paylater" ] }, "BanktransferPaymentMethod": { "title": "BanktransferPaymentMethod", "description": "banktransfer payment method", "example": { "banktransfer": { "channel": "link" } }, "type": "object", "properties": { "banktransfer": { "$ref": "#/components/schemas/Banktransfer" } }, "required": [ "banktransfer" ] }, "PaymentGatewayDetails": { "title": "PaymentGatewayDetails", "type": "object", "description": "payment gateway details present in the webhook response", "properties": { "gateway_name": { "type": "string" }, "gateway_order_id": { "type": "string" }, "gateway_payment_id": { "type": "string" }, "gateway_order_reference_id": { "type": "string" }, "gateway_status_code": { "type": "string" }, "gateway_settlement": { "type": "string" }, "gateway_reference_name": { "type": "string" } } }, "PaymentEntity": { "title": "PaymentEntity", "type": "object", "description": "payment entity full object", "example": { "$ref": "#/components/examples/payments_entity_list_example/value/0" }, "properties": { "cf_payment_id": { "type": "string" }, "order_id": { "type": "string" }, "entity": { "type": "string" }, "error_details": { "$ref": "#/components/schemas/ErrorDetailsInPaymentsEntity" }, "is_captured": { "type": "boolean" }, "order_amount": { "type": "number", "description": "Order amount can be different from payment amount if you collect service fee from the customer" }, "payment_group": { "type": "string", "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']" }, "payment_currency": { "type": "string" }, "payment_amount": { "type": "number" }, "payment_time": { "type": "string", "description": "This is the time when the payment was initiated" }, "payment_completion_time": { "type": "string", "description": "This is the time when the payment reaches its terminal state" }, "payment_status": { "type": "string", "enum": [ "SUCCESS", "NOT_ATTEMPTED", "FAILED", "USER_DROPPED", "VOID", "CANCELLED", "PENDING" ], "description": "The transaction status can be one of [\"SUCCESS\", \"NOT_ATTEMPTED\", \"FAILED\", \"USER_DROPPED\", \"VOID\", \"CANCELLED\", \"PENDING\"]" }, "payment_message": { "type": "string" }, "bank_reference": { "type": "string" }, "auth_id": { "type": "string" }, "order_currency": { "type": "string" }, "authorization": { "$ref": "#/components/schemas/AuthorizationInPaymentsEntity" }, "payment_method": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodCardInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodNetBankingInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodUPIInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodAppInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodCardlessEMIInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodPaylaterInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodCardEMIInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodBankTransferInPaymentsEntity" } ] }, "international_payment": { "$ref": "#/components/schemas/InternationalPaymentEntity" }, "payment_gateway_details": { "$ref": "#/components/schemas/PaymentGatewayDetails" }, "payment_surcharge": { "type": "object", "properties": { "payment_surcharge_service_charge": { "type": "number", "format": "float64" }, "payment_surcharge_service_tax": { "type": "number", "format": "float64" } } } } }, "TerminalPaymentEntity": { "title": "TerminalPaymentEntity", "type": "object", "description": "terminal payment entity full object", "example": { "$ref": "#/components/examples/terminal_payments_entity_list_example/value/0" }, "properties": { "cf_payment_id": { "type": "string" }, "order_id": { "type": "string" }, "entity": { "type": "string" }, "error_details": { "$ref": "#/components/schemas/ErrorDetailsInPaymentsEntity" }, "is_captured": { "type": "boolean" }, "order_amount": { "type": "number", "description": "Order amount can be different from payment amount if you collect service fee from the customer" }, "payment_group": { "type": "string", "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']" }, "payment_currency": { "type": "string" }, "payment_amount": { "type": "number" }, "payment_time": { "type": "string", "description": "This is the time when the payment was initiated" }, "payment_completion_time": { "type": "string", "description": "This is the time when the payment reaches its terminal state" }, "payment_status": { "type": "string", "enum": [ "SUCCESS", "NOT_ATTEMPTED", "FAILED", "USER_DROPPED", "VOID", "CANCELLED", "PENDING" ], "description": "The transaction status can be one of [\"SUCCESS\", \"NOT_ATTEMPTED\", \"FAILED\", \"USER_DROPPED\", \"VOID\", \"CANCELLED\", \"PENDING\"]" }, "payment_message": { "type": "string" }, "bank_reference": { "type": "string" }, "auth_id": { "type": "string" }, "authorization": { "$ref": "#/components/schemas/AuthorizationInPaymentsEntity" }, "customer_details": { "$ref": "#/components/schemas/CustomerDetails" }, "payment_method": { "oneOf": [ { "$ref": "#/components/schemas/PaymentMethodCardInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodNetBankingInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodUPIInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodAppInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodCardlessEMIInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodPaylaterInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodCardEMIInPaymentsEntity" }, { "$ref": "#/components/schemas/PaymentMethodBankTransferInPaymentsEntity" } ] }, "payment_gateway_details": { "$ref": "#/components/schemas/PaymentGatewayDetails" } } }, "PaymentLinkCustomerDetails": { "title": "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.", "example": { "customer_id": "7112AAA812234", "customer_email": "john@cashfree.com", "customer_phone": "9908734801", "customer_name": "John Doe", "customer_bank_account_number": "1518121112", "customer_bank_ifsc": "XITI0000001", "customer_bank_code": 3333 }, "type": "object", "properties": { "customer_id": { "type": "string", "description": "A unique identifier for the customer. Use alphanumeric values only.", "minLength": 3, "maxLength": 50 }, "customer_email": { "type": "string", "description": "Customer email address.", "minLength": 3, "maxLength": 100 }, "customer_phone": { "type": "string", "description": "Customer phone number.", "minLength": 10, "maxLength": 10 }, "customer_name": { "type": "string", "description": "Name of the customer.", "minLength": 3, "maxLength": 100 }, "customer_bank_account_number": { "type": "string", "description": "Customer bank account. Required if you want to do a bank account check (TPV)", "minLength": 3, "maxLength": 20 }, "customer_bank_ifsc": { "type": "string", "description": "Customer bank IFSC. Required if you want to do a bank account check (TPV)" }, "customer_bank_code": { "type": "number", "description": "Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV)" } }, "required": [ "customer_phone" ] }, "PaymentLinkOrderEntity": { "title": "PaymentLinkOrderEntity", "type": "object", "description": "The complete order entity", "example": { "$ref": "#/components/examples/order_entity_list_example/value/0" }, "properties": { "cf_order_id": { "type": "string", "description": "unique id generated by cashfree for your order" }, "link_id": { "type": "string", "description": "link id of the order" }, "order_id": { "type": "string", "description": "order_id sent during the api request" }, "entity": { "type": "string", "description": "Type of the entity." }, "order_currency": { "type": "string", "description": "Currency of the order. Example INR" }, "order_amount": { "type": "number" }, "order_status": { "type": "string", "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" }, "payment_session_id": { "type": "string" }, "order_expiry_time": { "type": "string", "format": "date-time" }, "order_note": { "type": "string", "description": "Additional note for order" }, "created_at": { "type": "string", "format": "date-time", "description": "When the order was created at cashfree's server", "example": "2022-08-16T14:45:38+05:30" }, "order_splits": { "type": "array", "items": { "$ref": "#/components/schemas/VendorSplit" } }, "customer_details": { "$ref": "#/components/schemas/PaymentLinkCustomerDetails" }, "order_meta": { "$ref": "#/components/schemas/OrderMeta" }, "order_tags": { "$ref": "#/components/schemas/OrderTags" } } }, "PaymentMethodAppInPaymentsEntity": { "title": "PaymentMethodAppInPaymentsEntity", "description": "payment method app object in payment entity", "example": { "channel": "link", "provider": "paytm", "phone": "1234512345" }, "type": "object", "properties": { "app": { "type": "object", "properties": { "channel": { "type": "string" }, "provider": { "type": "string" }, "phone": { "type": "string" } } } } }, "PaymentMethodBankTransferInPaymentsEntity": { "title": "PaymentMethodBankTransferInPaymentsEntity", "description": "payment method bank transfer object in payment entity", "example": { "channel": "link", "banktransfer_bank_name": "BANK_TRANSFER", "banktransfer_ifsc": "", "banktransfer_account_number": "" }, "type": "object", "properties": { "banktransfer": { "type": "object", "properties": { "channel": { "type": "string" }, "banktransfer_bank_name": { "type": "string" }, "banktransfer_ifsc": { "type": "string" }, "banktransfer_account_number": { "type": "string" } } } } }, "PaymentMethodCardEMIInPaymentsEntity": { "title": "PaymentMethodCardEMIInPaymentsEntity", "description": "payment method card emi object in payment entity", "example": { "channel": "link", "card_number": "41111xxxxxx111", "card_network": "visa", "card_type": "credit_card", "card_country": "IN", "card_bank_name": "HDFC Bank", "card_network_reference_id": "100212023061229" }, "type": "object", "properties": { "emi": { "type": "object", "properties": { "channel": { "type": "string" }, "card_number": { "type": "string" }, "card_network": { "type": "string" }, "card_type": { "type": "string" }, "card_country": { "type": "string" }, "card_bank_name": { "type": "string" }, "card_network_reference_id": { "type": "string" }, "emi_tenure": { "type": "number" }, "emi_details": { "type": "object", "properties": { "emi_amount": { "type": "number" }, "emi_tenure": { "type": "number" }, "emi_interest": { "type": "number" } } } } } } }, "PaymentMethodCardInPaymentsEntity": { "title": "PaymentMethodCardInPaymentsEntity", "description": "payment method card object in payment entity", "example": { "channel": "link", "card_number": "41111xxxxxx111", "card_network": "visa", "card_type": "credit_card", "card_country": "IN", "card_bank_name": "HDFC Bank", "card_network_reference_id": "100212023061229", "instrument_id": "3fc5814b-e732-4a71-b2ee-94b4f147d9e1" }, "type": "object", "properties": { "card": { "type": "object", "properties": { "channel": { "type": "string" }, "card_number": { "type": "string" }, "card_network": { "type": "string" }, "card_type": { "type": "string" }, "card_country": { "type": "string" }, "card_bank_name": { "type": "string" }, "card_network_reference_id": { "type": "string" }, "instrument_id": { "type": "string" } } } } }, "PaymentMethodCardlessEMIInPaymentsEntity": { "title": "PaymentMethodCardlessEMIInPaymentsEntity", "description": "payment method carless object in payment entity", "example": { "channel": "link", "provider": "flexmoney", "phone": "9908761211" }, "type": "object", "properties": { "cardless_emi": { "type": "object", "properties": { "channel": { "type": "string" }, "provider": { "type": "string" }, "phone": { "type": "string" } } } } }, "PaymentMethodNetBankingInPaymentsEntity": { "title": "PaymentMethodNetBankingInPaymentsEntity", "description": "netbanking payment method object for pay", "example": { "channel": "link", "netbanking_bank_code": 3044, "netbanking_bank_name": "State Bank of India" }, "type": "object", "properties": { "netbanking": { "type": "object", "properties": { "channel": { "type": "string" }, "netbanking_bank_code": { "type": "integer" }, "netbanking_bank_name": { "type": "string" }, "netbanking_ifsc": { "type": "string" }, "netbanking_account_number": { "type": "string" } } } }, "required": [ "channel", "netbanking_bank_name", "netbanking_bank_code" ] }, "PaymentMethodPaylaterInPaymentsEntity": { "title": "PaymentMethodPaylaterInPaymentsEntity", "description": "paylater payment method object for pay api", "example": { "channel": "link", "provider": "lazypay", "phone": "9908761211" }, "type": "object", "properties": { "paylater": { "type": "object", "properties": { "channel": { "type": "string" }, "provider": { "type": "string" }, "phone": { "type": "string" } } } } }, "PaymentMethodUPIInPaymentsEntity": { "title": "PaymentMethodUPIInPaymentsEntity", "description": "UPI payment method for pay api", "example": { "channel": "collect", "upi_id": "980123781@upi", "upi_payer_ifsc": "AXL1234", "upi_payer_account_number": "XXXXXXX6024" }, "type": "object", "properties": { "upi": { "type": "object", "properties": { "channel": { "type": "string" }, "upi_id": { "type": "string" }, "upi_payer_ifsc": { "type": "string" }, "upi_payer_account_number": { "type": "string" } } } }, "required": [ "channel" ] }, "PaymentMethodsFilters": { "title": "PaymentMethodsFilters", "type": "object", "example": { "payment_methods": null }, "description": "Filter for Payment Methods", "properties": { "payment_methods": { "type": "array", "description": "Array of payment methods to be filtered. This is optional, by default all payment methods will be returned. Possible values in [ 'debit_card', 'credit_card', 'prepaid_card', 'corporate_credit_card', 'upi', 'wallet', 'netbanking', 'banktransfer', 'paylater', 'paypal', 'debit_card_emi', 'credit_card_emi', 'upi_credit_card', 'upi_ppi', 'cardless_emi', 'account_based_payment' ]", "items": { "$ref": "#/components/schemas/MethodsType" } } } }, "PaymentMethodsQueries": { "title": "PaymentMethodsQueries", "description": "Payment Method Query Object", "type": "object", "example": { "amount": 100 }, "properties": { "amount": { "type": "number", "description": "Amount of the order.", "minimum": 1, "example": 100 }, "order_id": { "type": "string", "description": "OrderId of the order. Either of `order_id` or `order_amount` is mandatory.", "minLength": 3, "maxLength": 50, "format": "string", "example": "order_413462PK1RI1IwYB1X69LgzUQWiSxYDF" } } }, "PaymentModeDetails": { "description": "payment mode eligiblity object", "properties": { "nick": { "type": "string", "example": "motak_kahindra_bank" }, "display": { "type": "string", "example": "Motak Mahindra Bank" }, "eligibility": { "type": "boolean", "example": false }, "code": { "type": "number", "example": 3001 } } }, "RateLimitError": { "title": "RateLimitError", "description": "Error when rate limit is breached for your api", "example": { "message": "Too many requests from IP. Check headers", "code": "request_failed", "type": "rate_limit_error" }, "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "type": { "type": "string", "enum": [ "rate_limit_error" ], "description": "rate_limit_error" } } }, "ReconEntity": { "title": "ReconEntity", "description": "Settlement detailed recon response", "example": { "cursor": "cursor-uid", "limit": 9, "data": [ { "cf_settlement_id": "45345", "settlement_date": "2022-08-16T14:45:24+05:30", "sale_type": "CREDIT", "event_amount": 3000, "amount_settled": 2796.46, "event_settlement_amount": 2800, "event_currency": "INR", "payment_till": "2022-08-16T14:45:00+05:30", "event_id": "45345", "event_type": "SETTLEMENT", "service_charge": 0, "service_tax": 0, "settlement_utr": "PGI45345", "payment_from": "2022-08-16T14:14:55+05:30", "settlement_initiated_on": "2022-08-16T14:45:24+05:30", "adjustment": -200, "settlement_tax": 0.54, "event_time": "2022-08-16T14:45:07+05:30", "settlement_charge": 3, "entity": "recon", "remarks": "Settled", "event_status": "PAID", "settlement_type": "INSTANT_SETTLEMENT", "payment_group": "CREDIT_CARD", "forex_conversion_handling_charge": 11.12, "forex_conversion_handling_tax": 1.12, "charges_currency": "INR" }, { "cf_settlement_id": "45356", "settlement_date": "2022-08-16T14:45:14+05:30", "sale_type": "CREDIT", "event_amount": 0, "amount_settled": 0, "event_settlement_amount": 0, "event_currency": "INR", "payment_till": "2022-08-16T14:45:14+05:30", "event_id": "45356", "event_type": "SETTLEMENT", "service_charge": 0, "service_tax": 0, "settlement_utr": "", "payment_from": "2022-08-16T14:45:14+05:30", "adjustment": 0, "settlement_tax": 0, "event_time": "2022-08-16T14:45:14+05:30", "settlement_charge": 0, "entity": "recon", "remarks": "No eligible transactions to settle", "event_status": "PAID", "settlement_type": "INSTANT_SETTLEMENT", "payment_group": "CREDIT_CARD", "forex_conversion_handling_charge": 11.12, "forex_conversion_handling_tax": 1.12, "charges_currency": "INR" }, { "cf_settlement_id": "45373", "settlement_date": "2022-08-16T14:45:38+05:30", "sale_type": "CREDIT", "event_amount": 0, "amount_settled": 0, "event_settlement_amount": 0, "event_currency": "INR", "payment_till": "2022-08-16T14:45:38+05:30", "event_id": "45373", "event_type": "SETTLEMENT", "service_charge": 0, "service_tax": 0, "settlement_utr": "", "payment_from": "2022-08-16T14:45:38+05:30", "adjustment": 0, "settlement_tax": 0, "event_time": "2022-08-16T14:45:38+05:30", "settlement_charge": 0, "entity": "recon", "remarks": "No eligible transactions to settle", "event_status": "PAID", "settlement_type": "INSTANT_SETTLEMENT", "payment_group": "CREDIT_CARD", "forex_conversion_handling_charge": 11.12, "forex_conversion_handling_tax": 1.12, "charges_currency": "INR" }, { "cf_settlement_id": "45406", "split_service_charge": 0, "sale_type": "DEBIT", "event_amount": 3067.26, "payment_service_charge": 0, "event_settlement_amount": 3067.26, "event_type": "DISPUTE", "order_amount": 3000, "payment_service_tax": 0, "closed_in_favor_of": "MERCHANT", "dispute_resolved_on": "2022-08-16 14:53:15", "event_status": "CLOSED", "settlement_date": "2022-08-16T14:45:24+05:30", "customer_phone": "8281554863", "dispute_note": "tesr", "event_currency": "INR", "event_id": "272", "settlement_utr": "PGI45406", "customer_email": "manideep.ellur@cashfree.com", "dispute_category": "1402-Duplicate Processing", "customer_name": "Manideep", "split_service_tax": 0, "vendor_commission": 0, "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG", "entity": "recon", "event_time": "2022-08-16T14:52:55+05:30", "payment_group": "CREDIT_CARD", "forex_conversion_handling_charge": 11.12, "forex_conversion_handling_tax": 1.12, "charges_currency": "INR" }, { "cf_settlement_id": "45406", "split_service_charge": 0, "sale_type": "CREDIT", "event_amount": 3067.26, "payment_service_charge": 0, "event_settlement_amount": 3067.26, "event_type": "DISPUTE_REVERSAL", "order_amount": 3000, "payment_service_tax": 0, "closed_in_favor_of": "MERCHANT", "dispute_resolved_on": "2022-08-16 14:53:15", "event_status": "CLOSED", "settlement_date": "2022-08-16T14:45:24+05:30", "customer_phone": "8281554863", "dispute_note": "tesr", "event_currency": "INR", "event_id": "272", "settlement_utr": "PGI45406", "customer_email": "manideep.ellur@cashfree.com", "dispute_category": "1402-Duplicate Processing", "customer_name": "Manideep", "split_service_tax": 0, "vendor_commission": 0, "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG", "entity": "recon", "event_time": "2022-08-16T14:52:55+05:30", "payment_group": "CREDIT_CARD" }, { "cf_settlement_id": "45345", "event_id": "45345", "event_type": "OTHER_ADJUSTMENT", "sale_type": "CREDIT", "event_amount": 3000, "adjustment_remarks": "INSTANT_SETTLEMENT_COMPUTE", "event_currency": "INR", "event_time": "2022-08-16T14:45:07+05:30", "entity": "recon", "event_settlement_amount": 3000, "payment_group": "CREDIT_CARD" }, { "cf_settlement_id": "45345", "event_id": "45345", "event_type": "OTHER_ADJUSTMENT", "sale_type": "DEBIT", "event_amount": 3, "adjustment_remarks": "INSTANT_SETTLEMENT_CHARGE", "event_currency": "INR", "event_time": "2022-08-16T14:45:21+05:30", "entity": "recon", "event_settlement_amount": 3, "payment_group": "CREDIT_CARD" }, { "cf_settlement_id": "45345", "event_id": "45345", "event_type": "OTHER_ADJUSTMENT", "sale_type": "DEBIT", "event_amount": 0.54, "adjustment_remarks": "INSTANT_SETTLEMENT_TAX", "event_currency": "INR", "event_time": "2022-08-16T14:45:21+05:30", "entity": "recon", "event_settlement_amount": 0.54 }, { "cf_settlement_id": "45345", "event_id": "45345", "event_type": "OTHER_ADJUSTMENT", "sale_type": "DEBIT", "event_amount": 2796.46, "adjustment_remarks": "INSTANT_SETTLEMENT_SWEEP", "event_currency": "INR", "event_time": "2022-08-16T14:45:21+05:30", "entity": "recon", "event_settlement_amount": 2796.46, "payment_group": "CREDIT_CARD" } ] }, "properties": { "cursor": { "type": "string", "description": "Specifies from where the next set of settlement details should be fetched." }, "limit": { "type": "integer", "description": "Number of settlements you want to fetch in the next iteration." }, "data": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string", "description": "Unique ID associated with the event." }, "event_type": { "type": "string", "description": "The event type can be SETTLEMENT, PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT." }, "event_settlement_amount": { "type": "number", "description": "Amount that is part of the settlement corresponding to the event." }, "event_amount": { "type": "number", "description": "Amount of the event. Example, refund amount, dispute amount, payment amount, etc." }, "sale_type": { "type": "string", "description": "Indicates if it is CREDIT/DEBIT sale." }, "event_status": { "type": "string", "description": "Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED." }, "entity": { "type": "string", "description": "Recon" }, "event_time": { "type": "string", "description": "Time associated with the event. Example, transaction time, dispute initiation time" }, "event_currency": { "type": "string", "description": "Curreny type - INR." }, "order_id": { "type": "string", "description": "Unique order ID. Alphanumeric and only '-' and '_' allowed." }, "order_amount": { "type": "number", "description": "The amount which was passed at the order creation time." }, "customer_phone": { "type": "string", "description": "Customer phone number." }, "customer_email": { "type": "string", "description": "Customer email." }, "customer_name": { "type": "string", "description": "Customer name." }, "payment_amount": { "type": "number", "description": "Payment amount captured." }, "payment_utr": { "type": "string", "description": "Unique transaction reference number of the payment." }, "payment_time": { "type": "string", "description": "Date and time when the payment was initiated." }, "payment_service_charge": { "type": "number", "description": "Service charge applicable for the payment." }, "payment_service_tax": { "type": "number", "description": "Service tax applicable on the payment." }, "cf_payment_id": { "type": "string", "description": "Cashfree Payments unique ID to identify a payment." }, "cf_settlement_id": { "type": "string", "description": "Unique ID to identify the settlement." }, "settlement_date": { "type": "string", "description": "Date and time when the settlement was processed." }, "settlement_utr": { "type": "string", "description": "Unique transaction reference number of the settlement." }, "split_service_charge": { "type": "number", "description": "Service charge that is applicable for splitting the payment." }, "split_service_tax": { "type": "number", "description": "Service tax applicable for splitting the amount to vendors." }, "vendor_commission": { "type": "number", "description": "Vendor commission applicable for this transaction." }, "closed_in_favor_of": { "type": "string", "description": "Specifies whether the dispute was closed in favor of the merchant or customer. /n Possible values - Merchant, Customer" }, "dispute_resolved_on": { "type": "string", "description": "Date and time when the dispute was resolved." }, "dispute_category": { "type": "string", "description": "Category of the dispute - Dispute code and the reason for dispute is shown." }, "dispute_note": { "type": "string", "description": "Note regarding the dispute." }, "refund_processed_at": { "type": "string", "description": "Date and time when the refund was processed." }, "refund_arn": { "type": "string", "description": "The bank reference number for the refund." }, "refund_note": { "type": "string", "description": "A refund note for your reference." }, "refund_id": { "type": "string", "description": "An unique ID to associate the refund with." }, "adjustment_remarks": { "type": "string", "description": "Other adjustment remarks." }, "adjustment": { "type": "number", "description": "Amount that is adjusted from the settlement amount because of any credit/debit event such as refund, refund_reverse etc." }, "service_tax": { "type": "number", "description": "Service tax applicable on the settlement amount." }, "service_charge": { "type": "number", "description": "Service charge applicable on the settlement amount." }, "amount_settled": { "type": "number", "description": "Net amount that is settled after considering the adjustments, settlement charge and tax." }, "payment_from": { "type": "string", "description": "The start time of the time range of the payments considered for the settlement." }, "payment_till": { "type": "string", "description": "The end time of time range of the payments considered for the settlement." }, "reason": { "type": "string", "description": "Reason for settlement failure." }, "settlement_initiated_on": { "type": "string", "description": "Date and time when the settlement was initiated." }, "settlement_type": { "type": "string", "description": "Type of settlement. Possible values - Standard, Instant, On demand." }, "settlement_charge": { "type": "number", "description": "Settlement charges applicable on the settlement." }, "settlement_tax": { "type": "number", "description": "Settlement tax applicable on the settlement." }, "remarks": { "type": "string", "description": "Remarks on the settlement." }, "forex_conversion_handling_charge": { "type": "number", "description": "Cashfree forex conversion charges for processing transaction" }, "forex_conversion_handling_tax": { "type": "number", "description": "Cashfree forex conversion tax for processing transaction" }, "charges_currency": { "type": "string", "description": "Cashfree charges currency for a event type" } } } } } }, "RefundEntity": { "title": "RefundEntity", "description": "The refund entity", "type": "object", "example": { "cf_payment_id": "918812", "cf_refund_id": "1553338", "refund_id": "REF-123", "order_id": "c6G-QMcbm1848", "entity": "refund", "refund_amount": 100.81, "refund_currency": "INR", "refund_note": "Refund for order #123", "refund_status": "SUCCESS", "refund_type": "MERCHANT_INITIATED", "refund_splits": [], "status_description": "In Progress", "refund_arn": "RF12312", "metadata": { "option": "myotpion" }, "created_at": "2021-07-25T08:57:52+05:30", "processed_at": "2021-07-25T12:57:52+05:30", "refund_charge": 0, "refund_mode": "STANDARD", "forex_conversion_handling_charge": 11.12, "forex_conversion_handling_tax": 1.12, "forex_conversion_rate": 84.24, "charges_currency": "INR" }, "properties": { "cf_payment_id": { "type": "string", "description": "Cashfree Payments ID of the payment for which refund is initiated" }, "cf_refund_id": { "type": "string", "description": "Cashfree Payments ID for a refund" }, "order_id": { "type": "string", "description": "Merchant’s order Id of the order for which refund is initiated" }, "refund_id": { "type": "string", "description": "Merchant’s refund ID of the refund" }, "entity": { "type": "string", "enum": [ "refund" ], "description": "Type of object" }, "refund_amount": { "type": "number", "description": "Amount that is refunded" }, "refund_currency": { "type": "string", "description": "Currency of the refund amount" }, "refund_note": { "type": "string", "description": "Note added by merchant for the refund" }, "refund_status": { "type": "string", "enum": [ "SUCCESS", "PENDING", "CANCELLED", "ONHOLD" ], "description": "This can be one of [\"SUCCESS\", \"PENDING\", \"CANCELLED\", \"ONHOLD\", \"FAILED\"]" }, "refund_arn": { "type": "string", "description": "The bank reference number for refund" }, "refund_charge": { "type": "number", "description": "Charges in INR for processing refund" }, "status_description": { "type": "string", "description": "Description of refund status" }, "metadata": { "type": "object", "description": "Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs" }, "refund_splits": { "type": "array", "items": { "$ref": "#/components/schemas/VendorSplit" } }, "refund_type": { "type": "string", "enum": [ "PAYMENT_AUTO_REFUND", "MERCHANT_INITIATED", "UNRECONCILED_AUTO_REFUND" ], "description": "This can be one of [\"PAYMENT_AUTO_REFUND\", \"MERCHANT_INITIATED\", \"UNRECONCILED_AUTO_REFUND\"]" }, "refund_mode": { "type": "string", "description": "Method or speed of processing refund" }, "created_at": { "type": "string", "description": "Time of refund creation" }, "processed_at": { "type": "string", "description": "Time when refund was processed successfully" }, "refund_speed": { "$ref": "#/components/schemas/RefundSpeed" }, "forex_conversion_handling_charge": { "type": "number", "description": "Cashfree forex conversion charges for refund processing" }, "forex_conversion_handling_tax": { "type": "number", "description": "Cashfree forex conversion tax for refund processing" }, "forex_conversion_rate": { "type": "number", "description": "Cashfree forex conversion rate for refund processing" }, "charges_currency": { "type": "string", "description": "Cashfree refund charges currency for a refund" } } }, "RefundSpeed": { "title": "RefundSpeed", "description": "How fast refund has to be proecessed", "type": "object", "example": { "requested": "STANDARD", "accepted": "STANDARD", "processed": "STANDARD", "message": "Error message, if any" }, "properties": { "requested": { "type": "string", "description": "Requested speed of refund." }, "accepted": { "type": "string", "description": "Accepted speed of refund." }, "processed": { "type": "string", "description": "Processed speed of refund." }, "message": { "type": "string", "description": "Error message, if any for refund_speed request" } } }, "SavedInstrumentMeta": { "title": "InstrumentMeta", "description": "Card instrument meta information", "properties": { "card_network": { "type": "string", "description": "card scheme/network of the saved card. Example visa, mastercard", "example": "VISA" }, "card_bank_name": { "type": "string", "description": "Issuing bank name of saved card", "example": "HDFC Bank" }, "card_country": { "type": "string", "description": "Issuing country of saved card", "example": "IN" }, "card_type": { "type": "string", "description": "Type of saved card", "example": "DEBIT_CARD" }, "card_token_details": { "type": "object", "example": { "par": "somepar", "expiry_month": "12", "expiry_year": "23" } } } }, "SchemeArray": { "title": "Scheme array", "type": "string", "example": "visa", "description": "array of card schemes like visa, master etc" }, "EmptyObject": { "type": "object", "additionalProperties": false }, "SettlementEntity": { "title": "SettlementsEntity", "description": "Settlement entity object", "type": "object", "example": { "cf_payment_id": "553338", "order_id": "order-12-127", "entity": "settlement", "order_amount": 100, "payment_time": "2021-07-13T13:13:59+05:30", "service_charge": 10, "service_tax": 1.8, "settlement_amount": 88.2, "cf_settlement_id": "6121238", "transfer_id": 238, "transfer_time": "2021-07-25T12:57:52+05:30", "transfer_utr": "N87912312", "order_currency": "INR", "settlement_currency": "INR", "forex_conversion_handling_charge": 11.12, "forex_conversion_handling_tax": 1.12, "forex_conversion_rate": 84.24, "charges_currency": "INR" }, "properties": { "cf_payment_id": { "type": "string" }, "cf_settlement_id": { "type": "string" }, "settlement_currency": { "type": "string" }, "order_id": { "type": "string" }, "entity": { "type": "string" }, "order_amount": { "type": "number" }, "payment_time": { "type": "string" }, "service_charge": { "type": "number" }, "service_tax": { "type": "number" }, "settlement_amount": { "type": "number" }, "settlement_id": { "type": "integer" }, "transfer_id": { "type": "integer" }, "transfer_time": { "type": "string" }, "transfer_utr": { "type": "string" }, "forex_conversion_handling_charge": { "type": "number", "description": "Cashfree forex conversion charges for refund processing" }, "forex_conversion_handling_tax": { "type": "number", "description": "Cashfree forex conversion tax for refund processing" }, "forex_conversion_rate": { "type": "number", "description": "Cashfree forex conversion rate for refund processing" }, "charges_currency": { "type": "string", "description": "Cashfree refund charges currency for a refund" } } }, "VendorBalance": { "title": "VendorBalance", "description": "Vendor Balance entity object", "type": "object", "properties": { "merchant_id": { "type": "number" }, "vendor_id": { "type": "string" }, "merchant_unsettled": { "type": "number" }, "vendor_unsettled": { "type": "number" } } }, "VendorBalanceTransferCharges": { "title": "VendorBalanceTransferCharges", "description": "Vendor Balance Transfer Charges entity object", "type": "object", "properties": { "service_charges": { "type": "number", "format": "float64" }, "service_tax": { "type": "number", "format": "float64" }, "amount": { "type": "number", "format": "float64" }, "billed_to": { "type": "string" }, "is_postpaid": { "type": "boolean" } } }, "DisputesEntity": { "title": "DisputesEntity", "type": "object", "example": { "dispute_id": 433447817, "dispute_type": "DISPUTE", "reason_code": 1401, "reason_description": "Fraud Transaction", "dispute_amount": 10, "dispute_amount_currency": "INR", "created_at": "2023-01-18T11:26:58", "respond_by": "2023-01-19T00:00:00", "updated_at": "2023-01-18T11:26:58", "resolved_at": "9999-09-09T00:00:00", "dispute_status": "DISPUTE_DOCS_RECEIVED", "cf_dispute_remarks": "Load Testing", "preferred_evidence": [ { "document_type": "Delivery/Service Proof", "document_description": "Proof that the cardholder/customer received the goods or services." } ], "dispute_evidence": [ { "document_id": 18150, "document_name": "disputeSampleFile.pdf", "document_type": "DeliveryProof" } ], "order_details": { "order_id": "Load_test_0103_FGA4HF12AC", "order_currency": "INR", "order_amount": 10, "cf_payment_id": 1489901523, "payment_currency": "INR", "payment_amount": 10 }, "customer_details": { "customer_name": "John Ellur", "customer_phone": 9876543210, "customer_email": "john@cashfree.com" } }, "properties": { "dispute_id": { "type": "integer" }, "dispute_type": { "type": "string", "enum": [ "DISPUTE", "CHARGEBACK", "RETRIEVAL", "PRE_ARBITRATION", "ARBITRATION" ] }, "reason_code": { "type": "string" }, "reason_description": { "type": "string" }, "dispute_amount": { "type": "number", "description": "Dispute amount may differ from transaction amount for partial cases." }, "dispute_amount_currency": { "type": "string", "description": "Dispute amount currency for a dispute" }, "created_at": { "type": "string", "description": "This is the time when the dispute was created." }, "respond_by": { "type": "string", "description": "This is the time by which evidence should be submitted to contest the dispute." }, "updated_at": { "type": "string", "description": "This is the time when the dispute case was updated." }, "resolved_at": { "type": "string", "description": "This is the time when the dispute case was closed." }, "dispute_status": { "type": "string", "enum": [ "DISPUTE_CREATED", "DISPUTE_DOCS_RECEIVED", "DISPUTE_UNDER_REVIEW", "DISPUTE_MERCHANT_WON", "DISPUTE_MERCHANT_LOST", "DISPUTE_MERCHANT_ACCEPTED", "DISPUTE_INSUFFICIENT_EVIDENCE", "CHARGEBACK_CREATED", "CHARGEBACK_DOCS_RECEIVED", "CHARGEBACK_UNDER_REVIEW", "CHARGEBACK_MERCHANT_WON", "CHARGEBACK_MERCHANT_LOST", "CHARGEBACK_MERCHANT_ACCEPTED", "CHARGEBACK_INSUFFICIENT_EVIDENCE", "RETRIEVAL_CREATED", "RETRIEVAL_DOCS_RECEIVED", "RETRIEVAL_UNDER_REVIEW", "RETRIEVAL_MERCHANT_WON", "RETRIEVAL_MERCHANT_LOST", "RETRIEVAL_MERCHANT_ACCEPTED", "RETRIEVAL_INSUFFICIENT_EVIDENCE", "PRE_ARBITRATION_CREATED", "PRE_ARBITRATION_DOCS_RECEIVED", "PRE_ARBITRATION_UNDER_REVIEW", "PRE_ARBITRATION_MERCHANT_WON", "PRE_ARBITRATION_MERCHANT_LOST", "PRE_ARBITRATION_MERCHANT_ACCEPTED", "PRE_ARBITRATION_INSUFFICIENT_EVIDENCE", "ARBITRATION_CREATED", "ARBITRATION_DOCS_RECEIVED", "ARBITRATION_UNDER_REVIEW", "ARBITRATION_MERCHANT_WON", "ARBITRATION_MERCHANT_LOST", "ARBITRATION_MERCHANT_ACCEPTED", "ARBITRATION_INSUFFICIENT_EVIDENCE" ] }, "cf_dispute_remarks": { "type": "string" }, "preferred_evidence": { "$ref": "#/components/schemas/PreferredEvidence" }, "dispute_evidence": { "$ref": "#/components/schemas/DisputeEvidence" }, "order_details": { "$ref": "#/components/schemas/OrderDetailsInDisputesEntity" }, "customer_details": { "$ref": "#/components/schemas/CustomerDetailsInDisputesEntity" } } }, "DisputesEntityMerchantAccepted": { "title": "DisputesEntityMerchantAccepted", "type": "object", "example": { "dispute_id": 433447817, "dispute_type": "DISPUTE", "reason_code": 1401, "reason_description": "Fraud Transaction", "dispute_amount": 10, "created_at": "2023-01-18T11:26:58", "respond_by": "2023-01-19T00:00:00", "updated_at": "2023-01-18T11:26:58", "resolved_at": "2023-01-18T11:26:58", "dispute_status": "DISPUTE_MERCHANT_ACCEPTED", "cf_dispute_remarks": "Load Testing", "preferred_evidence": [], "dispute_evidence": [], "order_details": { "order_id": "Load_test_0103_FGA4HF12AC", "order_currency": "INR", "order_amount": 10, "cf_payment_id": 1489901523, "payment_currency": "INR", "payment_amount": 10 }, "customer_details": { "customer_name": "John Ellur", "customer_phone": 8281554863, "customer_email": "john@cashfree.com" } }, "properties": { "dispute_id": { "type": "integer" }, "dispute_type": { "type": "string", "enum": [ "DISPUTE", "CHARGEBACK", "RETRIEVAL", "PRE_ARBITRATION", "ARBITRATION" ] }, "reason_code": { "type": "string" }, "reason_description": { "type": "string" }, "dispute_amount": { "type": "number", "description": "Dispute amount may differ from transaction amount for partial cases." }, "created_at": { "type": "string", "description": "This is the time when the dispute was created." }, "respond_by": { "type": "string", "description": "This is the time by which evidence should be submitted to contest the dispute." }, "updated_at": { "type": "string", "description": "This is the time when the dispute case was updated." }, "resolved_at": { "type": "string", "description": "This is the time when the dispute case was closed." }, "dispute_status": { "type": "string", "enum": [ "DISPUTE_CREATED", "DISPUTE_DOCS_RECEIVED", "DISPUTE_UNDER_REVIEW", "DISPUTE_MERCHANT_WON", "DISPUTE_MERCHANT_LOST", "DISPUTE_MERCHANT_ACCEPTED", "DISPUTE_INSUFFICIENT_EVIDENCE", "CHARGEBACK_CREATED", "CHARGEBACK_DOCS_RECEIVED", "CHARGEBACK_UNDER_REVIEW", "CHARGEBACK_MERCHANT_WON", "CHARGEBACK_MERCHANT_LOST", "CHARGEBACK_MERCHANT_ACCEPTED", "CHARGEBACK_INSUFFICIENT_EVIDENCE", "RETRIEVAL_CREATED", "RETRIEVAL_DOCS_RECEIVED", "RETRIEVAL_UNDER_REVIEW", "RETRIEVAL_MERCHANT_WON", "RETRIEVAL_MERCHANT_LOST", "RETRIEVAL_MERCHANT_ACCEPTED", "RETRIEVAL_INSUFFICIENT_EVIDENCE", "PRE_ARBITRATION_CREATED", "PRE_ARBITRATION_DOCS_RECEIVED", "PRE_ARBITRATION_UNDER_REVIEW", "PRE_ARBITRATION_MERCHANT_WON", "PRE_ARBITRATION_MERCHANT_LOST", "PRE_ARBITRATION_MERCHANT_ACCEPTED", "PRE_ARBITRATION_INSUFFICIENT_EVIDENCE", "ARBITRATION_CREATED", "ARBITRATION_DOCS_RECEIVED", "ARBITRATION_UNDER_REVIEW", "ARBITRATION_MERCHANT_WON", "ARBITRATION_MERCHANT_LOST", "ARBITRATION_MERCHANT_ACCEPTED", "ARBITRATION_INSUFFICIENT_EVIDENCE" ] }, "cf_dispute_remarks": { "type": "string" }, "preferred_evidence": { "$ref": "#/components/schemas/PreferredEvidence" }, "dispute_evidence": { "$ref": "#/components/schemas/DisputeEvidence" }, "order_details": { "$ref": "#/components/schemas/OrderDetailsInDisputesEntity" }, "customer_details": { "$ref": "#/components/schemas/CustomerDetailsInDisputesEntity" } } }, "OrderDetailsInDisputesEntity": { "title": "OrderDetailsInDisputesEntity", "example": { "order_id": "Load_test_0103_FGA4HF12AC", "order_currency": "INR", "order_amount": 10, "cf_payment_id": 1489901523, "payment_currency": "INR", "payment_amount": 10 }, "type": "object", "properties": { "order_id": { "type": "string" }, "order_currency": { "type": "string" }, "order_amount": { "type": "number" }, "cf_payment_id": { "type": "string" }, "payment_currency": { "type": "string" }, "payment_amount": { "type": "number" } } }, "CustomerDetailsInDisputesEntity": { "title": "CustomerDetailsInDisputesEntity", "example": { "customer_name": "Manideep Ellur", "customer_phone": 8281554863, "customer_email": "manideep.ellur@cashfree.com" }, "type": "object", "properties": { "customer_name": { "type": "string" }, "customer_phone": { "type": "string" }, "customer_email": { "type": "string" } } }, "PreferredEvidence": { "title": "EvidencesToContestDispute", "type": "array", "example": { "preferred_evidence": [ { "document_type": "Delivery/Service Proof", "document_description": "Proof that the cardholder/customer received the goods or services." }, { "document_type": "Statement of Service", "document_description": "Account Statement of wallet where funds were loaded by customer." } ] }, "items": { "$ref": "#/components/schemas/EvidencesToContestDispute" } }, "DisputeEvidence": { "title": "DisputeEvidence", "example": [ { "document_id": 18150, "document_name": "disputeSampleFile.pdf", "document_type": "DeliveryProof" } ], "type": "array", "items": { "$ref": "#/components/schemas/Evidence" } }, "Evidence": { "title": "Evidence", "example": { "document_id": 18150, "document_name": "disputeSampleFile.pdf", "document_type": "DeliveryProof" }, "type": "object", "properties": { "document_id": { "type": "integer" }, "document_name": { "type": "string" }, "document_type": { "type": "string" } } }, "EvidencesToContestDispute": { "title": "EvidencesToContestDispute", "example": { "preferred_evidence": [ { "document_type": "Delivery/Service Proof", "document_description": "Proof that the cardholder/customer received the goods or services." }, { "document_type": "Statement of Service", "document_description": "Account Statement of wallet where funds were loaded by customer." } ] }, "type": "object", "properties": { "document_type": { "type": "string" }, "document_description": { "type": "string" } } }, "VendorEntity": { "title": "VendorEntity", "description": "Vendor entity object", "type": "object", "example": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "phone": 9876543210, "name": "customer", "vendor_id": "johntest11111", "added_on": "2023-03-02 12:12:56", "updated_on": "2023-03-02 12:12:57", "bank": [], "upi": null, "schedule_option": [], "vendor_type": "PG", "account_type": "BUSINESS", "business_type": "NBFC", "remarks": "Invalid bank account", "related_docs": [ { "vendor_id": "johntest11111", "doc_type": "CIN_NUMBER", "doc_value": "L00000Aa0000AaA000000", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "GSTIN_NUMBER", "doc_value": "11AAAAA1111A1Z0", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PAN_NUMBER", "doc_value": "BIAPA2934N", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PASSPORT_NUMBER", "doc_value": "L6892603", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "UIDAI_NUMBER", "doc_value": 753624181019, "status": "IN_REVIEW", "remarks": null } ] }, "properties": { "email": { "type": "string" }, "status": { "type": "string" }, "phone": { "type": "string" }, "name": { "type": "string" }, "vendor_id": { "type": "string" }, "added_on": { "type": "string" }, "updated_on": { "type": "string" }, "bank": { "type": "array", "items": { "$ref": "#/components/schemas/BankDetails" } }, "upi": { "type": "string" }, "schedule_option": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleOption" } }, "vendor_type": { "type": "string" }, "account_type": { "type": "string" }, "business_type": { "type": "string" }, "remarks": { "type": "string" }, "related_docs": { "type": "array", "items": { "type": "object", "properties": { "vendor_id": { "type": "string" }, "doc_type": { "type": "string" }, "doc_value": { "type": "string" }, "status": { "type": "string" }, "remarks": { "type": "string" } } } } } }, "VendorDocumentsResponse": { "title": "VendorDocumentsResponse", "description": "Get Vendor Documents", "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "vendor_id": { "type": "string" }, "doc_type": { "type": "string" }, "doc_value": { "type": "string" }, "status": { "type": "string" }, "remarks": { "type": "string" } } } } } }, "VendorDocumentDownloadResponse": { "title": "VendorDocumentDownloadResponse", "description": "Download Vendor Document", "type": "object", "properties": { "download_url": { "type": "string" } } }, "UploadVendorDocumentsResponse": { "title": "UploadVendorDocumentsResponse", "description": "Upload Vendor Document", "type": "object", "properties": { "vendor_id": { "type": "string" }, "doc_type": { "type": "string" }, "doc_value": { "type": "string" }, "status": { "type": "string" }, "remarks": { "type": "string" } } }, "StaticSplitResponse": { "title": "StaticSplitResponse", "description": "Static Split Response", "type": "object", "properties": { "active": { "type": "boolean" }, "terminal_id": { "type": "string" }, "terminal_reference_id": { "type": "number" }, "product_type": { "type": "string" }, "scheme": { "type": "array", "items": { "type": "object", "properties": { "merchantVendorId": { "type": "string" }, "percentage": { "type": "string" } } } }, "added_on": { "type": "string" } } }, "ESOrderReconResponse": { "title": "ESOrderReconResponse", "description": "ES Order Recon Response", "type": "object", "properties": { "cursor": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "float64" }, "settlement_eligibility_time": { "type": "string" }, "status": { "type": "string" }, "merchant_order_id": { "type": "string" }, "tx_time": { "type": "string" }, "settled": { "type": "string" }, "entity_id": { "type": "string" }, "merchant_settlement_utr": { "type": "string" }, "currency": { "type": "string" }, "sale_type": { "type": "string" }, "customer_name": { "type": "string" }, "customer_email": { "type": "string" }, "customer_phone": { "type": "string" }, "merchant_vendor_commission": { "type": "string" }, "split_service_charge": { "type": "string" }, "split_service_tax": { "type": "string" }, "pg_service_tax": { "type": "string" }, "pg_service_charge": { "type": "string" }, "pg_charge_postpaid": { "type": "string" }, "merchant_settlement_id": { "type": "string" }, "added_on": { "type": "string" }, "tags": { "type": "string" }, "entity_type": { "type": "string" }, "settlement_initiated_on": { "type": "string" }, "settlement_time": { "type": "string" }, "order_splits": { "type": "array", "items": { "type": "object", "properties": { "split": { "type": "array", "items": { "type": "object", "properties": { "merchant_vendor_id": { "type": "string" }, "percentage": { "type": "number", "format": "float64" }, "tags": { "type": "object" } } } }, "created_at": { "type": "string" } } } }, "eligible_split_balance": { "type": "string" } } } }, "limit": { "type": "integer" } } }, "SplitOrderReconSuccessResponse": { "title": "SplitOrderReconSuccessResponse", "description": "Split Order Reconciliation Request Body", "type": "object", "properties": { "settlement": { "type": "object", "description": "Details of the settlement information.", "properties": { "entity": { "type": "string", "description": "Type of entity. Example: \"settlement\"." }, "cf_settlement_id": { "type": "integer", "format": "int64", "description": "Unique Cashfree settlement ID." }, "cf_payment_id": { "type": "integer", "format": "int64", "description": "Unique Cashfree Payment ID associated with the order." }, "order_id": { "type": "string", "description": "Unique identifier for the order." }, "order_currency": { "type": "string", "description": "Currency of the order. Example: \"INR\"." }, "transfer_id": { "type": "string", "nullable": true, "description": "Unique transfer ID if available, otherwise null." }, "order_amount": { "type": "number", "format": "float64", "description": "Total amount of the order." }, "service_charge": { "type": "number", "format": "float64", "description": "Service charge for the order." }, "service_tax": { "type": "number", "format": "float64", "description": "Service tax for the order." }, "settlement_amount": { "type": "number", "format": "float64", "description": "Amount to be settled after charges and tax." }, "settlement_currency": { "type": "string", "description": "Currency of the settlement. Example: \"INR\"." }, "transfer_utr": { "type": "string", "nullable": true, "description": "UTR (Unique Transaction Reference) for the transfer if available, otherwise null." }, "transfer_time": { "type": "string", "format": "date-time", "nullable": true, "description": "Time of transfer if available, otherwise null." }, "payment_time": { "type": "string", "format": "date-time", "description": "Timestamp when payment was made." } } }, "refunds": { "type": "array", "items": { "type": "object" }, "description": "List of refunds associated with the order, if any." }, "vendors": { "type": "array", "description": "List of vendor settlements associated with the split settlement.", "items": { "type": "object", "properties": { "vendor_id": { "type": "string", "description": "Unique identifier for the vendor." }, "settlement_id": { "type": "integer", "format": "int64", "description": "Settlement ID associated with the vendor." }, "settlement_amount": { "type": "number", "format": "float64", "description": "Settlement amount allocated to the vendor." }, "settlement_eligibility_date": { "type": "string", "format": "date-time", "description": "Date and time when the vendor is eligible for the settlement." } } } } } }, "SimulationResponse": { "title": "SimulationResponse", "description": "Simulation response object", "type": "object", "example": { "simulation_id": "sim_2900842gV18Lhh7owswLj5XF0uHHUn1CX", "entity": "PAYMENTS", "entity_id": "14934289844", "entity_simulation": { "payment_status": "FAILED", "payment_error_code": "ISSUER_NOT_AVAILABLE" } }, "properties": { "simulation_id": { "type": "string" }, "entity": { "type": "string" }, "entity_id": { "type": "string" }, "entity_simulation": { "$ref": "#/components/schemas/EntitySimulationResponse" } } }, "SplitAfterPaymentResponse": { "title": "SplitAfterPaymentResponse", "description": "Split After Payment Response", "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } } }, "AdjustVendorBalanceResponse": { "title": "AdjustVendorBalanceResponse", "description": "Adjust Vendor Balance Response", "type": "object", "properties": { "settlement_id": { "type": "number" }, "transfer_details": { "$ref": "#/components/schemas/TransferDetails" }, "balances": { "$ref": "#/components/schemas/BalanceDetails" }, "charges": { "$ref": "#/components/schemas/ChargesDetails" } } }, "VendorAdjustmentSuccessResponse": { "title": "VendorAdjustmentSuccessResponse", "description": "Vendor Adjustment Success Response", "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "string" } } }, "CreateVendorResponse": { "title": "CreateVendorResponse", "description": "Create Vendor Response", "type": "object", "example": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "bank": [], "upi": [], "phone": 9876543210, "name": "customer", "vendor_id": "TestAccount11", "schedule_option": [], "kyc_details": [], "dashboard_access": false, "bank_details": null }, "properties": { "email": { "type": "string" }, "status": { "type": "string" }, "bank": { "type": "array", "items": { "$ref": "#/components/schemas/BankDetails" } }, "upi": { "type": "string" }, "phone": { "type": "number" }, "name": { "type": "string" }, "vendor_id": { "type": "string" }, "schedule_option": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleOption" } }, "kyc_details": { "type": "array", "items": { "$ref": "#/components/schemas/KycDetails" } }, "dashboard_access": { "type": "boolean" }, "bank_details": { "type": "string" } } }, "UpdateVendorResponse": { "title": "UpdateVendorResponse", "description": "Update Vendor Response", "type": "object", "example": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "bank": [], "upi": [], "phone": 9876543210, "name": "customer", "vendor_id": "TestAccount11", "schedule_option": [], "kyc_details": [], "dashboard_access": false, "bank_details": null, "related_docs": [ { "vendor_id": "johntest11111", "doc_type": "CIN_NUMBER", "doc_value": "L00000Aa0000AaA000000", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "GSTIN_NUMBER", "doc_value": "11AAAAA1111A1Z0", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PAN_NUMBER", "doc_value": "BIAPA2934N", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PASSPORT_NUMBER", "doc_value": "L6892603", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "UIDAI_NUMBER", "doc_value": 753624181019, "status": "IN_REVIEW", "remarks": null } ] }, "properties": { "email": { "type": "string" }, "status": { "type": "string" }, "bank": { "type": "array", "items": { "$ref": "#/components/schemas/BankDetails" } }, "upi": { "type": "string" }, "added_on": { "type": "string" }, "updated_on": { "type": "string" }, "vendor_type": { "type": "string" }, "account_type": { "type": "string" }, "business_type": { "type": "string" }, "phone": { "type": "number" }, "name": { "type": "string" }, "vendor_id": { "type": "string" }, "schedule_option": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleOption" } }, "kyc_details": { "type": "array", "items": { "$ref": "#/components/schemas/KycDetails" } }, "dashboard_access": { "type": "boolean" }, "bank_details": { "type": "string" }, "related_docs": { "type": "array", "items": { "type": "object", "properties": { "vendor_id": { "type": "string" }, "doc_type": { "type": "string" }, "doc_value": { "type": "string" }, "status": { "type": "string" }, "remarks": { "type": "string" } } } } } }, "CreateVendorRequest": { "title": "CreateVendorRequest", "description": "Create Vendor Request", "type": "object", "example": { "vendor_id": "vendortest123", "status": "ACTIVE", "name": "customer", "email": "johndoe@cashfree.com", "phone": 9876543210, "verify_account": true, "dashboard_access": true, "schedule_option": 1, "bank": [], "upi": [], "kyc_details": [] }, "properties": { "vendor_id": { "type": "string", "description": "Specify the unique Vendor ID to identify the beneficiary. Alphanumeric and underscore (_) allowed." }, "status": { "type": "string", "description": "Specify the status of vendor that should be updated. Possible values: ACTIVE,BLOCKED, DELETED" }, "name": { "type": "string", "description": "Specify the name of the vendor to be updated. Name should not have any special character except . / - &" }, "email": { "type": "string", "description": "Specify the vendor email ID that should be updated. String in email ID format (Ex:johndoe_1@cashfree.com) should contain @ and dot (.)" }, "phone": { "type": "string", "description": "Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits, 8 - 12 characters after excluding +91)." }, "verify_account": { "type": "boolean", "description": "Specify if the vendor bank account details should be verified. Possible values: true or false" }, "dashboard_access": { "type": "boolean", "description": "Update if the vendor will have dashboard access or not. Possible values are: true or false" }, "schedule_option": { "type": "number", "description": "Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table. If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements." }, "bank": { "type": "array", "description": "Specify the vendor bank account details to be updated.", "items": { "$ref": "#/components/schemas/BankDetails" } }, "upi": { "type": "array", "description": "Updated beneficiary upi vpa. Alphanumeric, dot (.), hyphen (-), at sign (@), and underscore allowed (100 character limit). Note: underscore and dot (.) gets accepted before and after @, but hyphen (-) is only accepted before @ sign.", "items": { "$ref": "#/components/schemas/UpiDetails" } }, "kyc_details": { "type": "array", "description": "Specify the kyc details that should be updated.", "items": { "$ref": "#/components/schemas/KycDetails" } } }, "required": [ "vendor_id", "status", "name", "email", "phone", "kyc_details" ] }, "StaticSplitRequest": { "title": "StaticSplitRequest", "description": "Static Split Request", "type": "object", "properties": { "active": { "type": "boolean", "description": "Specify if the split is to be active or not. Possible values: true/false" }, "terminal_id": { "type": "string", "description": "For Subscription payments, the subscription reference ID is to be shared as the terminal ID. Incase for Payment Gateway terminal ID is non-mandatory. Mention as 0 if not applicable." }, "terminal_reference_id": { "type": "number", "description": "You can share additional information using the reference ID." }, "product_type": { "type": "string", "description": "Specify the product for which the split should be created. If you want split to be created for Payment Gateway pass value as \"PG\". If you want split to be created for Subscription, pass value as \"SBC\". Accepted values - \"STATIC_QR\", \"SBC\", \"PG\", \"EPOS\"." }, "scheme": { "type": "array", "description": "Provide the split scheme details.", "items": { "type": "object", "properties": { "merchantVendorId": { "type": "string", "description": "Specify the merchant vendor ID to create the split scheme for the payment." }, "percentage": { "type": "string", "description": "Specify the percentage of amount to be split." } } } } }, "required": [ "active", "product_type", "scheme" ] }, "ESOrderReconRequest": { "title": "ESOrderReconRequest", "description": "ES Order Recon Request", "type": "object", "properties": { "filters": { "type": "object", "description": "Provide the filter object details.", "properties": { "start_date": { "type": "string", "description": "Specify the start data from which you want to get the recon data." }, "end_date": { "type": "string", "description": "Specify the end data till which you want to get the recon data." }, "order_ids": { "type": "array", "description": "Please provide list of order ids for which you want to get the recon data.", "items": { "type": "string" } } } }, "pagination": { "type": "object", "description": "Set limit based on your requirement. Pagination limit will fetch a set of orders, next set of orders can be generated using the cursor shared in previous response of the same API.", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "description": "Set the minimum/maximum limit for number of filtered data. Min value - 10, Max value - 100." } } } }, "required": [ "filters", "pagination" ] }, "SplitAfterPaymentRequest": { "title": "SplitAfterPaymentRequest", "description": "Split After Payment Request", "type": "object", "properties": { "split": { "type": "array", "description": "Specify the vendors order split details.", "items": { "type": "object", "properties": { "vendor_id": { "type": "string", "description": "Specify the merchant vendor ID to split the payment." }, "amount": { "type": "number", "description": "Specify the amount to be split to the vendor." }, "percentage": { "type": "number", "description": "Specify the percentage of amount to be split." }, "tags": { "type": "object", "maxProperties": 20, "description": "Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 255 } } } } }, "disable_split": { "type": "boolean", "description": "Specify if you want to end the split or continue creating further splits in future." } }, "required": [ "split" ] }, "AdjustVendorBalanceRequest": { "title": "AdjustVendorBalanceRequest", "description": "Adjust Vendor Balance Request", "type": "object", "properties": { "transfer_from": { "type": "string", "description": "Mention to whom you want to transfer the on demand balance. Possible values - MERCHANT, VENDOR." }, "transfer_type": { "type": "string", "description": "Mention the type of transfer. Possible values: ON_DEMAND." }, "transfer_amount": { "type": "number", "format": "float64", "description": "Mention the on demand transfer amount." }, "remark": { "type": "string", "description": "Mention remarks if any for the on demand transfer." }, "tags": { "type": "object", "description": "Provide additional data fields using tags." } }, "required": [ "transfer_from", "transfer_type", "transfer_amount" ] }, "VendorAdjustmentRequest": { "title": "VendorAdjustmentRequest", "description": "Vendor Adjustment Request Body", "type": "object", "properties": { "vendor_id": { "type": "string", "description": "The unique identifier of the vendor to whom the adjustment is applied" }, "adjustment_id": { "type": "integer", "format": "int64", "description": "The unique identifier for the adjustment transaction." }, "amount": { "type": "number", "format": "float64", "description": "The adjustment amount to be applied." }, "type": { "type": "string", "description": "The type of adjustment. Possible values: CREDIT, DEBIT." }, "remarks": { "type": "string", "description": "Remarks for the adjustment transaction, if any." } }, "required": [ "vendor_id", "adjustment_id", "amount", "type" ] }, "UpdateVendorRequest": { "title": "UpdateVendorRequest", "description": "Update Vendor Request", "type": "object", "example": { "status": "ACTIVE", "name": "customer", "email": "johndoe@cashfree.com", "phone": 9876543210, "verify_account": true, "dashboard_access": true, "schedule_option": 1, "bank": [], "upi": [], "kyc_details": [] }, "properties": { "status": { "type": "string", "description": "Specify the status of vendor that should be updated. Possible values: ACTIVE,BLOCKED, DELETED" }, "name": { "type": "string", "description": "Specify the name of the vendor to be updated. Name should not have any special character except . / - &" }, "email": { "type": "string", "description": "Specify the vendor email ID that should be updated. String in email ID format (Ex:johndoe_1@cashfree.com) should contain @ and dot (.)" }, "phone": { "type": "string", "description": "Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits, 8 - 12 characters after excluding +91)." }, "verify_account": { "type": "boolean", "description": "Specify if the vendor bank account details should be verified. Possible values: true or false" }, "dashboard_access": { "type": "boolean", "description": "Update if the vendor will have dashboard access or not. Possible values are: true or false" }, "schedule_option": { "type": "number", "description": "Specify the settlement cycle to be updated. View the settlement cycle details from the \"Settlement Cycles Supported\" table. If no schedule option is configured, the settlement cycle ID \"1\" will be in effect. Select \"8\" or \"9\" if you want to schedule instant vendor settlements." }, "bank": { "type": "array", "description": "Specify the vendor bank account details to be updated.", "items": { "$ref": "#/components/schemas/BankDetails" } }, "upi": { "type": "array", "description": "Updated beneficiary upi vpa. Alphanumeric, dot (.), hyphen (-), at sign (@), and underscore allowed (100 character limit). Note: underscore and dot (.) gets accepted before and after @, but hyphen (-) is only accepted before @ sign.", "items": { "$ref": "#/components/schemas/UpiDetails" } }, "kyc_details": { "type": "array", "description": "Specify the kyc details that should be updated.", "items": { "$ref": "#/components/schemas/KycDetails" } } }, "required": [ "status", "name", "email", "phone", "schedule_option", "kyc_details" ] }, "CreateOrderSettlementRequestBody": { "type": "object", "description": "Create Order Settlement Object", "example": { "order_id": "order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H", "meta_data": { "cbriks_id": "CBRIKS_004", "settlement_date": "2024-04-12" } }, "properties": { "order_id": { "type": "string", "description": "OrderId of the order." }, "meta_data": { "type": "object", "properties": { "cbriks_id": { "type": "string", "description": "Meta data cbricks ID to be used for reporting purpose." }, "settlement_date": { "type": "string", "format": "date", "description": "Requested Settlement Date." } } } }, "required": [ "order_id", "meta_data", "meta_data.settlement_date" ] }, "SettlementFetchReconRequest": { "type": "object", "description": "Recon Request Object", "example": { "pagination": { "limit": 10, "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==" }, "filters": { "cf_settlement_ids": [ "4234233" ], "settlement_utrs": [ "utr1", "utr2" ], "start_date": "2022-07-20T00:00:00Z", "end_date": "2022-07-21T23:59:59Z" } }, "properties": { "pagination": { "type": "object", "properties": { "limit": { "type": "integer", "description": "The number of settlements you want to fetch. Maximum limit is 1000, default value is 10." }, "cursor": { "type": "string", "description": "Specifies from where the next set of settlement details should be fetched." } }, "description": "To fetch the next set of settlements, pass the cursor received in the response to the next API call. \n To receive the data for the first time, pass the cursor as null. \n Limit would be number of settlements that you want to receive.", "required": [ "limit" ] }, "filters": { "type": "object", "properties": { "cf_settlement_ids": { "type": "array", "items": { "type": "string" }, "description": "List of settlement IDs for which you want the settlement reconciliation details." }, "settlement_utrs": { "type": "array", "items": { "type": "string" }, "description": "List of settlement UTRs for which you want the settlement reconciliation details." }, "start_date": { "type": "string", "description": "Specify the start date from when you want the settlement reconciliation details." }, "end_date": { "type": "string", "description": "Specify the end date till when you want the settlement reconciliation details." } }, "description": "Specify either the Settlement ID, Settlement UTR, or start date and end date to fetch the settlement details." } }, "required": [ "pagination", "filters" ] }, "SettlementReconEntity": { "title": "SettlementReconEntity", "description": "Recon object for settlement", "example": { "cursor": "cursor", "limit": 7, "data": [ { "cutomer_details": { "customer_bank_account_number": "1234567", "customer_bank_code": "123", "customer_bank_ifsc": "SBIN000123", "customer_email": "manideep.ellur@cashfree.com", "customer_id": "Manideep", "customer_name": "Manideep", "customer_phone": "8281554863" }, "dispute_details": { "closed_in_favor_of": null, "dispute_category": null, "dispute_note": null, "dispute_resolved_on": null, "resolved_on": null }, "event_details": { "entity": "recon", "event_amount": 200, "event_currency": "INR", "event_id": "43594", "event_remarks": "null,", "event_service_charge": 2, "event_service_tax": 0, "event_settlement_amount": 200, "event_status": "SUCCESS", "event_time": "2025-01-16T15:06:41+05:30", "event_type": "PAYMENT", "sale_type": "CREDIT" }, "order_details": { "order_amount": 3000, "order_currency": "INR", "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG", "order_tags": { "key1": "value1", "key2": "value2" } }, "payment_details": { "bank_reference": 210396, "cf_payment_id": "1234881617186388204", "charges_currency": "INR", "forex_conversion_handling_charge": 0, "forex_conversion_handling_tax": 0, "payment_amount": null, "payment_currency": "INR", "payment_mode": "CREDIT_CARD", "payment_service_charge": 2, "payment_service_tax": 0, "payment_time": null, "status": null }, "refund_details": { "refund_arn": "null,", "refund_id": "null,", "refund_note": "null,", "refund_processed_at": null }, "settlement_details": { "adjustment": null, "amount_settled": null, "cf_settlement_id": "1639775422", "payment_from": null, "payment_till": null, "reason": null, "remarks": null, "service_charge": null, "service_tax": null, "settlement_charge": null, "settlement_date": "2025-01-16T18:33:51+05:30", "settlement_initiated_on": "2025-01-16T15:33:51+05:30", "settlement_tax": null, "settlement_type": null, "split_service_charge": 0, "split_service_tax": 0, "utr": "PGI45406", "vendor_commission": 0 } }, { "cutomer_details": { "customer_bank_account_number": "1234567", "customer_bank_code": "123", "customer_bank_ifsc": "SBIN000123", "customer_email": "manideep.ellur@cashfree.com", "customer_id": "Manideep", "customer_name": "Manideep", "customer_phone": "8281554863" }, "dispute_details": { "closed_in_favor_of": "MERCHANT", "dispute_category": "1402-Duplicate Processing", "dispute_note": "test", "dispute_resolved_on": "2025-01-16 10:15:10", "resolved_on": "2025-01-16 10:15:10" }, "event_details": { "entity": "recon", "event_amount": 200, "event_currency": "INR", "event_id": "43594", "event_remarks": "null,", "event_service_charge": 2, "event_service_tax": 0, "event_settlement_amount": 200, "event_status": "SUCCESS", "event_time": "2025-01-16T15:06:41+05:30", "event_type": "DISPUTE", "sale_type": "DEBIT" }, "order_details": { "order_amount": 3000, "order_currency": "INR", "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG", "order_tags": { "key1": "value1", "key2": "value2" } }, "payment_details": { "bank_reference": 210396, "cf_payment_id": "1234881617186388204", "charges_currency": "INR", "forex_conversion_handling_charge": 0, "forex_conversion_handling_tax": 0, "payment_amount": null, "payment_currency": "INR", "payment_mode": "CREDIT_CARD", "payment_service_charge": 2, "payment_service_tax": 0, "payment_time": null, "status": null }, "refund_details": { "refund_arn": "null,", "refund_id": "null,", "refund_note": "null,", "refund_processed_at": null }, "settlement_details": { "adjustment": null, "amount_settled": null, "cf_settlement_id": "1639775422", "payment_from": null, "payment_till": null, "reason": null, "remarks": null, "service_charge": null, "service_tax": null, "settlement_charge": null, "settlement_date": "2025-01-16T18:33:51+05:30", "settlement_initiated_on": "2025-01-16T15:33:51+05:30", "settlement_tax": null, "settlement_type": null, "split_service_charge": 0, "split_service_tax": 0, "utr": "PGI45406", "vendor_commission": 0 } }, { "cutomer_details": { "customer_bank_account_number": "1234567", "customer_bank_code": "123", "customer_bank_ifsc": "SBIN000123", "customer_email": "manideep.ellur@cashfree.com", "customer_id": "Manideep", "customer_name": "Manideep", "customer_phone": "8281554863" }, "dispute_details": { "closed_in_favor_of": null, "dispute_category": null, "dispute_note": null, "dispute_resolved_on": null, "resolved_on": null }, "event_details": { "entity": "recon", "event_amount": 200, "event_currency": "INR", "event_id": "43594", "event_remarks": "FUND_SWEEP_REVERSAL", "event_service_charge": null, "event_service_tax": null, "event_settlement_amount": 200, "event_status": "SUCCESS", "event_time": "2025-01-16T15:06:41+05:30", "event_type": "FUND_SWEEP_REVERSAL", "sale_type": "CREDIT" }, "order_details": { "order_amount": null, "order_currency": null, "order_id": null, "order_tags": null }, "payment_details": { "bank_reference": null, "cf_payment_id": null, "charges_currency": null, "forex_conversion_handling_charge": null, "forex_conversion_handling_tax": null, "payment_amount": null, "payment_currency": null, "payment_mode": null, "payment_service_charge": null, "payment_service_tax": null, "payment_time": null, "status": null }, "refund_details": { "refund_arn": "null,", "refund_id": "null,", "refund_note": "null,", "refund_processed_at": null }, "settlement_details": { "adjustment": null, "amount_settled": null, "cf_settlement_id": "1639775422", "payment_from": null, "payment_till": null, "reason": null, "remarks": null, "service_charge": null, "service_tax": null, "settlement_charge": null, "settlement_date": "2025-01-16T18:33:51+05:30", "settlement_initiated_on": "2025-01-16T15:33:51+05:30", "settlement_tax": null, "settlement_type": null, "split_service_charge": 0, "split_service_tax": 0, "utr": "PGI45406", "vendor_commission": 0 } } ] }, "properties": { "cursor": { "type": "string", "description": "Specifies from where the next set of settlement details should be fetched." }, "limit": { "type": "integer", "description": "Number of settlements you want to fetch in the next iteration." }, "data": { "type": "array", "items": { "type": "object", "properties": { "event_details": { "type": "object", "properties": { "event_id": { "type": "string", "description": "Unique ID associated with the event." }, "event_type": { "type": "string", "description": "The event type can be PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT." }, "event_settlement_amount": { "type": "number", "description": "Amount that is part of the settlement corresponding to the event." }, "event_amount": { "type": "number", "description": "Amount corresponding to the event. Example, refund amount, dispute amount, payment amount, etc." }, "sale_type": { "type": "string", "description": "Indicates if it is CREDIT/DEBIT sale." }, "event_status": { "type": "string", "description": "Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED." }, "entity": { "type": "string", "description": "Recon" }, "event_time": { "type": "string", "description": "Time associated with the event. Example, transaction time, dispute initiation time" }, "event_currency": { "type": "string", "description": "Curreny type - INR." }, "event_service_charge": { "type": "number", "description": "Service charge for above event_type." }, "event_service_tax": { "type": "number", "description": "Service tax for above event_type." }, "event_remarks": { "type": "number", "description": "Remarks for above event_type." } } }, "order_details": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Unique order ID. Alphanumeric and only '-' and '_' allowed." }, "order_amount": { "type": "number", "description": "The amount which was passed at the order creation time." }, "order_currency": { "type": "string", "description": "Order Curreny type - INR." }, "order_tags": { "type": "object", "description": "The order tags provided during order creation" } } }, "customer_details": { "type": "object", "properties": { "customer_phone": { "type": "string", "description": "Customer phone number." }, "customer_email": { "type": "string", "description": "Customer email." }, "customer_name": { "type": "string", "description": "Customer name." }, "customer_id": { "type": "string", "description": "Customer's id." }, "customer_bank_account_number": { "type": "string", "description": "Customer bank account number." }, "customer_bank_code": { "type": "string", "description": "Customer bank code." }, "customer_bank_ifsc": { "type": "string", "description": "Customer bank ifsc\"" } } }, "payment_details": { "type": "object", "properties": { "payment_amount": { "type": "number", "description": "Payment amount captured." }, "payment_currency": { "type": "string", "description": "Payment Curreny type - INR." }, "bank_reference": { "type": "string", "description": "Unique transaction reference number of the payment." }, "payment_time": { "type": "string", "description": "Date and time when the payment was initiated." }, "payment_mode": { "type": "string", "description": "Mode of the payment." }, "payment_service_charge": { "type": "number", "description": "Service charge applicable for the payment." }, "payment_service_tax": { "type": "number", "description": "Service tax applicable on the payment." }, "cf_payment_id": { "type": "string", "description": "Cashfree Payments unique ID to identify a payment." }, "status": { "type": "string", "description": "Status of the Payment." }, "forex_conversion_handling_charge": { "type": "string", "description": "Forex Conversion Service Charge." }, "forex_conversion_handling_tax": { "type": "string", "description": "Forex Conversion Service Tax." }, "charges_currency": { "type": "string", "description": "Forex Charges Curreny type - INR." } } }, "settlement_details": { "type": "object", "properties": { "cf_settlement_id": { "type": "string", "description": "Unique ID to identify the settlement." }, "settlement_date": { "type": "string", "description": "Date and time when the settlement was processed." }, "utr": { "type": "string", "description": "Unique transaction reference number of the settlement." }, "split_service_charge": { "type": "number", "description": "Service charge that is applicable for splitting the payment." }, "split_service_tax": { "type": "number", "description": "Service tax applicable for splitting the amount to vendors." }, "vendor_commission": { "type": "number", "description": "Vendor commission applicable for this transaction." }, "payment_from": { "type": "string", "description": "Date and time from settlement computed." }, "payment_till": { "type": "string", "description": "Date and time till settlement computed." }, "reason": { "type": "string", "description": "If any reason for settlement failure." }, "remarks": { "type": "string", "description": "Remarks related for settlement." }, "service_charge": { "type": "number", "description": "Service charge for the transactions." }, "service_tax": { "type": "number", "description": "Service tax for the transactions." }, "settlement_charge": { "type": "number", "description": "Settlement Service Charge." }, "settlement_initiated_on": { "type": "string", "description": "Date and time when Settlement initiated." }, "settlement_tax": { "type": "number", "description": "Settlement Service Tax." }, "settlement_type": { "type": "string", "description": "Type of Settlement, Example - Normal Settlement." } } }, "dispute_details": { "type": "object", "properties": { "closed_in_favor_of": { "type": "string", "description": "Specifies whether the dispute was closed in favor of the merchant or customer. Possible values - Merchant, Customer." }, "dispute_resolved_on": { "type": "string", "description": "Date and time when the dispute was resolved." }, "dispute_category": { "type": "string", "description": "Category of the dispute - Dispute code and the reason for dispute is shown." }, "dispute_note": { "type": "string", "description": "Note regarding the dispute." } } }, "refund_details": { "type": "object", "properties": { "refund_processed_at": { "type": "string", "description": "Date and time when the refund was processed." }, "refund_arn": { "type": "string", "description": "The bank reference number for refund." }, "refund_note": { "type": "string", "description": "A refund note for your reference." }, "refund_id": { "type": "string", "description": "An unique ID associated with the refund." } } } } } } } }, "SettlementWebhook": { "title": "SettlementWebhook", "description": "Settlement webhook object", "type": "object", "properties": { "data": { "type": "object", "title": "SettlementWebhookDataEntity", "description": "data entity in webhook", "properties": { "settlement": { "allOf": [ { "$ref": "#/components/schemas/SettlementEntity" } ] } } }, "event_time": { "type": "string", "example": "2021-10-07T19:42:44+05:30" }, "type": { "type": "string", "example": "PAYMENT_SUCCESS_WEBHOOK" } } }, "TerminalDetails": { "description": "Use this if you are creating an order for cashfree's softPOS", "example": { "added_on": "2023-08-04T13:12:58+05:30", "cf_terminal_id": "31051123", "last_updated_on": "2023-09-06T14:07:00+05:30", "terminal_address": "Banglore", "terminal_id": "terminal-123", "terminal_name": "test", "terminal_note": "POS vertical", "terminal_phone_no": "6309291183", "terminal_status": "ACTIVE", "terminal_type": "SPOS" }, "properties": { "added_on": { "description": "date time at which terminal is added", "type": "string" }, "cf_terminal_id": { "description": "Cashfree terminal id, this is a required parameter when you do not provide the terminal phone number.", "type": "string" }, "last_updated_on": { "description": "last instant when this terminal was updated", "type": "string" }, "terminal_address": { "description": "location of terminal", "type": "string" }, "terminal_id": { "description": "terminal id for merchant reference", "maxLength": 100, "minLength": 3, "type": "string" }, "terminal_name": { "description": "name of terminal/agent/storefront", "type": "string" }, "terminal_note": { "description": "note given by merchant while creating the terminal", "type": "string" }, "terminal_phone_no": { "description": "mobile num of the terminal/agent/storefront,This is a required parameter when you do not provide the cf_terminal_id.", "type": "string" }, "terminal_status": { "description": "status of terminal active/inactive", "type": "string" }, "terminal_type": { "description": "To identify the type of terminal product in use, in this case it is SPOS.", "maxLength": 10, "minLength": 4, "type": "string" } }, "required": [ "terminal_type" ], "title": "Terminal", "type": "object" }, "TerminalEntity": { "title": "TerminalEntity", "description": "Create terminal response object", "type": "object", "example": { "added_on": "023-10-12T11:12:39+05:30", "cf_terminal_id": 1838, "last_updated_on": "023-10-12T11:12:39+05:30", "terminal_address": "Bangalore", "terminal_email": "john@cashfree.com", "terminal_id": "test", "terminal_meta": { "terminal_operator": "dev test" }, "terminal_name": "john doe", "terminal_note": "POS vertical", "terminal_phone_no": 9876543214, "terminal_status": "DOCS_AWAITED", "terminal_type": "STOREFRONT" }, "properties": { "added_on": { "type": "string" }, "cf_terminal_id": { "type": "integer" }, "last_updated_on": { "type": "string" }, "terminal_address": { "type": "string" }, "terminal_email": { "type": "string" }, "terminal_type": { "type": "string" }, "teminal_id": { "type": "string" }, "terminal_name": { "type": "string" }, "terminal_note": { "type": "string" }, "terminal_phone_no": { "type": "string" }, "terminal_status": { "type": "string" }, "terminal_meta": { "description": "Terminal metadata, required field for storefront.", "properties": { "terminal_operator": { "description": "name of the STOREFRONT operator.", "type": "string" } }, "type": "object" } } }, "TerminalTransactionEntity": { "title": "TerminalTransactionEntity", "description": "Create terminal response object", "type": "object", "example": { "cf_payment_id": 42887, "payment_amount": 10, "payment_method": "LINK", "payment_url": "https://payments-test.cashfree.com/order/#4jWjotaRWEizB1BiCtPf", "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDolAAAABlBMVEX///8AAABVwtN+AAACWklEQVR42uyZPY7sIBCEy3JAyBE4Chdb+UfvYhyFIxASINdTNZ6dWc3mNu8NgbWyvw1a3dVdzeBzPue/PBNJHo7wB2LDWoCwl6i3aSCgAlgQyQNgXnyqWEsE4IcCAouAApcapoIq3rHdDnBpLhM5ZwCOexkV0JfUwobI/GuYNwdUUY5zWRxhugDwVnIXA128qfm9xtnK/ld13xvoxyX2+FYmx+29nd4cmCrmspLNb6ooMtWweZLbM5s3AAL8ZhVlFe8tilhD+45iCAANC3rLN/E6VZPjUACAXkx+r33o2rv60PkYwEQ2qUHjIM3cSQv4R4+6AZDnU7cVM1miy1Jw/hoJgMvyD/pWo0Vdw6FcDAWYund9W0lmc0ETiZ/yvxqgDLFakL2WPegtiGUgAC43vwHNBgMPb7GOBshmakN52GayYjr70G0AwGZW6uM37Ke3f86sIYCpgmWt0RRMNdIKeCovaSBABmivscmvWSOFrJDLX89sXg5AqwaZulXr40qPsH030gEAzSxu0oXsTrAwD69GOhIA9dCVJuw050l5WlRRL8m6HDCTYw+o0asT8dC/sQwEQDKgXJrsgfykxPuqi0EA2UwZTrUdAeHwtmylcQDTxWGTl6mFnanHnZ/e/nrgsXebRzB/06fw6xp1f+BxB2LLyZxX5WKXwZ/LSMB5y6q/ure3PLm3u+JrgfN+sotXachGffnhABWTjE22u+xFM+tnmIMA5jphhlPqruHPd0XdAbCK0sZq06sA4UB86VFDAOfvOM33XDCZK8arK74/8Dmf84+dvwEAAP//PizKiw+K9esAAAAASUVORK5CYII=", "timeout": "300000" }, "properties": { "cf_payment_id": { "type": "string" }, "payment_amount": { "type": "integer" }, "payment_method": { "type": "string" }, "payment_url": { "type": "string" }, "qrcode": { "type": "string" }, "timeout": { "type": "string" } } }, "SoundboxVpaEntity": { "title": "SoundboxVpaEntity", "description": "soundbox response object", "type": "object", "example": { "vpa": "cf.vpa-epos-gamma1018696837085fad68@sim", "cf_terminal_id": 3708, "device_serial_no": "abtest123", "merchant_name": "merchant-test", "language": "English" }, "properties": { "vpa": { "type": "string" }, "cf_terminal_id": { "type": "string" }, "device_serial_no": { "type": "string" }, "merchant_name": { "type": "string" }, "language": { "type": "string" } } }, "TerminateOrderRequest": { "title": "TerminateOrderRequest", "description": "Request to terminate an active order at Cashfree", "example": { "order_status": "TERMINATED" }, "type": "object", "properties": { "order_status": { "type": "string", "description": "To terminate an order, pass order_status as \"TERMINATED\". Please note, order might not be terminated - confirm with the order_status in response. \"TERMINATION_REQUESTED\" states that the request is recieved and we are working on it. If the order terminates successfully, status will change to \"TERMINATED\". Incase there's any active transaction which moved to success - order might not get terminated." } }, "required": [ "order_status" ] }, "UPIAuthorizeDetails": { "title": "UPIAuthorizeDetails", "description": "object when you are using preauth in UPI in order pay", "example": { "authorization": { "approve_by": "2022-07-02T10:20:12+05:30", "start_time": "2022-09-21T12:34:34Z", "end_time": "2022-10-22T12:34:34Z" } }, "type": "object", "properties": { "approve_by": { "type": "string", "description": "Time by which this authorization should be approved by the customer." }, "start_time": { "type": "string", "description": "This is the time when the UPI one time mandate will start" }, "end_time": { "type": "string", "description": "This is the time when the UPI mandate will be over. If the mandate has not been executed by this time, the funds will be returned back to the customer after this time." } } }, "UPIPaymentMethod": { "title": "UPIPaymentMethod", "description": "Complete payment method for UPI collect", "example": { "upi": { "channel": "collect", "upi_id": "rajnandan1@okxdfcbank" } }, "type": "object", "properties": { "upi": { "$ref": "#/components/schemas/Upi" } }, "required": [ "upi" ] }, "UpdateTerminalEntity": { "title": "UpdateTerminalEntity", "description": "Update terminal response", "type": "object", "example": { "added_on": "023-10-12T11:12:39+05:30", "cf_terminal_id": 1838, "last_updated_on": "023-10-12T11:12:39+05:30", "terminal_address": "Cashfree Payments India Pvt Ltd, Vaishnavi Summit, No. 6/B, Summit, 80 Feet Rd, Koramangala 1A Block, Koramangala 3 Block, Koramangala, Bengaluru, Karnataka 560034", "terminal_email": "john@cashfree.com", "terminal_id": "test", "terminal_meta": { "terminal_operator": "dev test" }, "terminal_name": "john doe", "terminal_note": "POS vertical", "terminal_phone_no": 9876543214, "terminal_status": "DOCS_AWAITED", "terminal_type": "STOREFRONT" }, "properties": { "added_on": { "type": "string" }, "cf_terminal_id": { "type": "integer" }, "last_updated_on": { "type": "string" }, "terminal_address": { "type": "string" }, "terminal_email": { "type": "string" }, "terminal_type": { "type": "string" }, "teminal_id": { "type": "string" }, "terminal_name": { "type": "string" }, "terminal_note": { "type": "string" }, "terminal_phone_no": { "type": "string" }, "terminal_status": { "type": "string" }, "terminal_meta": { "description": "Terminal metadata, required field for storefront.", "properties": { "terminal_operator": { "description": "name of the STOREFRONT operator.", "type": "string" } }, "type": "object" } } }, "UpdateTerminalRequest": { "title": "Update Terminal", "description": "Request body to update terminal details.", "example": { "terminal_email": "john@cashfree.com", "terminal_phone_no": "9876543210", "terminal_meta": null, "terminal_status": "DOCS_AWAITED", "terminal_type": "STOREFRONT" }, "type": "object", "properties": { "terminal_email": { "type": "string", "description": "Mention the updated email ID of the terminal." }, "terminal_phone_no": { "type": "string", "description": "Terminal phone number to be updated.", "minLength": 10, "maxLength": 10 }, "terminal_meta": { "type": "object", "description": "Terminal metadata.", "properties": { "terminal_operator": { "description": "Name of the operator for the storefront.", "type": "string" } } }, "terminal_type": { "type": "string", "description": "Mention the terminal type to be updated. Possible values - AGENT, STOREFRONT." } }, "required": [ "terminal_type" ] }, "UpdateTerminalStatusRequest": { "title": "Update Terminal Status", "description": "Request body to update terminal status.", "example": { "terminal_status": "ACTIVE" }, "type": "object", "properties": { "terminal_status": { "type": "string", "description": "Status of the terminal to be updated. possible values - ACTIVE, INACTIVE." } }, "required": [ "terminal_status" ] }, "Upi": { "title": "Upi", "description": "UPI collect payment method object", "example": { "channel": "collect", "upi_id": "john@okxdfcbak", "upi_expiry_minutes": 10 }, "type": "object", "properties": { "channel": { "type": "string", "enum": [ "link", "collect", "qrcode" ], "description": "Specify the channel through which the payment must be processed. Can be one of [\"link\", \"collect\", \"qrcode\"]" }, "upi_id": { "type": "string", "description": "Customer UPI VPA to process payment. \n### Important\nThis is a required parameter for channel = `collect`\n" }, "upi_redirect_url": { "type": "boolean", "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" }, "upi_expiry_minutes": { "type": "number", "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" }, "authorize_only": { "type": "boolean", "description": "For one time mandate on UPI, set this as authorize_only = true." }, "authorization": { "$ref": "#/components/schemas/UPIAuthorizeDetails" } }, "required": [ "channel" ] }, "UploadTerminalDocs": { "title": "Upload Terminal Docs", "description": "Request body to upload terminal documents.", "example": { "doc_type": "PHOTOGRAPH", "doc_value": "john", "file": null }, "type": "object", "properties": { "doc_type": { "type": "string", "description": "Mention the document type you are uploading. Possible values - ADDRESSPROOF, PHOTOGRAPH." }, "doc_value": { "type": "string", "description": "Enter the display name of the uploaded file." }, "file": { "type": "string", "description": "Select the document that should be uploaded or provide the path of that file. You cannot upload a file that is more than 2MB in size." } }, "required": [ "doc_type", "doc_value", "file" ] }, "VendorSplit": { "title": "VendorSplit", "description": "Use to split order when cashfree's Easy Split is enabled for your account.", "type": "object", "example": { "vendor_id": "Vendor01", "amount": 100.12, "description": "order amount should be more than equal to 100.12" }, "properties": { "vendor_id": { "type": "string", "description": "Vendor id created in Cashfree system" }, "amount": { "type": "number", "description": "Amount which will be associated with this vendor" }, "percentage": { "type": "number", "description": "Percentage of order amount which shall get added to vendor account" }, "tags": { "type": "object", "maxProperties": 15, "description": "Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added", "additionalProperties": { "type": "object" } } }, "required": [ "vendor_id" ] }, "BankDetails": { "title": "BankDetails", "type": "object", "example": { "account_number": 123456111110, "account_holder": "JOHNDOE", "ifsc": "YESB0000262" }, "properties": { "account_number": { "type": "string" }, "account_holder": { "type": "string" }, "ifsc": { "type": "string" } } }, "TransferDetails": { "title": "TransferDetails", "type": "object", "example": { "vendor_id": "test03", "transfer_from": "VENDOR", "transfer_type": "ADJUSTMENT", "transfer_amount": 10, "remark": "Testing", "tags": [ { "product": "SHRT" }, { "size": 1 } ] }, "properties": { "vendor_id": { "type": "string" }, "transfer_from": { "type": "string" }, "transfer_type": { "type": "string" }, "transfer_amount": { "type": "number" }, "remark": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "product": { "type": "string" }, "size": { "type": "number" } } } } } }, "BalanceDetails": { "title": "BalanceDetails", "type": "object", "example": { "merchant_id": 152707, "vendor_id": "test03", "merchant_unsettled": 2442, "vendor_unsettled": 4757.42 }, "properties": { "merchant_id": { "type": "number" }, "vendor_id": { "type": "string" }, "merchant_unsettled": { "type": "number", "format": "float64" }, "vendor_unsettled": { "type": "number", "format": "float64" } } }, "ChargesDetails": { "title": "ChargesDetails", "type": "object", "example": { "service_charges": 2, "service_tax": 0.36, "amount": 10, "billed_to": "MERCHANT", "is_postpaid": true }, "properties": { "service_charges": { "type": "number", "format": "float64" }, "service_tax": { "type": "number", "format": "float64" }, "amount": { "type": "number", "format": "float64" }, "billed_to": { "type": "string" }, "is_postpaid": { "type": "boolean" } } }, "UpiDetails": { "title": "UpiDetails", "type": "object", "example": { "vpa": "success@upi", "account_holder": "JOHN DOE" }, "properties": { "vpa": { "type": "string" }, "account_holder": { "type": "string" } } }, "KycDetails": { "title": "KycDetails", "type": "object", "example": { "account_type": "BUSINESS", "business_type": "NBFC", "uidai": 753624181019, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000", "pan": "BIAPA2934N", "passport_number": "L6892603" }, "properties": { "account_type": { "type": "string" }, "business_type": { "type": "string" }, "uidai": { "type": "number" }, "gst": { "type": "string" }, "cin": { "type": "string" }, "pan": { "type": "string" }, "passport_number": { "type": "string" }, "driving_license": { "type": "string" }, "voter_id": { "type": "string" } } }, "ScheduleOption": { "title": "ScheduleOption", "type": "object", "example": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": true }, "properties": { "settlement_schedule_message": { "type": "string" }, "schedule_id": { "type": "number" }, "merchant_default": { "type": "boolean" } } }, "SubscriptionPaymentSplitItem": { "title": "SubscriptionPaymentSplitItem", "description": "Subscription Payment Split Item", "type": "object", "example": { "vendor_id": "123", "percentage": 12.05 }, "properties": { "vendor_id": { "type": "string", "description": "Vendor ID" }, "percentage": { "type": "number", "format": "float64", "description": "Percentage of the payment to be split to vendor" } } }, "AuthorizationDetails": { "title": "AuthorizationDetails", "description": "Details of the authorization done for the subscription. Returned in Get subscription and auth payments.", "type": "object", "example": { "authorization_amount": 1, "authorization_amount_refund": false, "authorization_reference": "", "authorization_time": "2022-06-14T23:47:52+05:30", "authorization_status": "INITIALIZED", "payment_id": "97877", "payment_method": "NPCI_SBC" }, "properties": { "authorization_amount": { "type": "number", "format": "float64", "description": "Authorization amount for the auth payment." }, "authorization_amount_refund": { "type": "boolean", "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." }, "authorization_reference": { "type": "string", "description": "Authorization reference. UMN for UPI, UMRN for EMandate/Physical Mandate and Enrollment ID for cards." }, "authorization_time": { "type": "string", "description": "Authorization time." }, "authorization_status": { "type": "string", "description": "Status of the authorization." }, "payment_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the transaction." }, "payment_method": { "type": "string", "description": "Payment method used for the authorization." } } }, "SubscriptionCustomerDetails": { "title": "CustomerDetails", "description": "Subscription customer details.", "type": "object", "example": { "customer_name": "Test Cust", "customer_email": "test@gmail.com", "customer_phone": "9900755700", "customer_bank_account_holder_name": "", "customer_bank_account_number": "", "customer_bank_ifsc": "", "customer_bank_code": "", "customer_bank_account_type": "" }, "properties": { "customer_name": { "type": "string", "description": "Name of the customer." }, "customer_email": { "type": "string", "description": "Email of the customer." }, "customer_phone": { "type": "string", "description": "Phone number of the customer." }, "customer_bank_account_holder_name": { "type": "string", "description": "Bank holder name of the customer." }, "customer_bank_account_number": { "type": "string", "description": "Bank account number of the customer." }, "customer_bank_ifsc": { "type": "string", "description": "IFSC code of the customer." }, "customer_bank_code": { "type": "string", "description": "Bank code of the customer. Refer to https://www.npci.org.in/PDF/nach/live-members-e-mandates/Live-Banks-in-API-E-Mandate.pdf" }, "customer_bank_account_type": { "type": "string", "description": "Bank account type of the customer." } }, "required": [ "customer_email", "customer_phone" ] }, "PlanEntity": { "title": "PlanEntity", "description": "The response returned for Get, Create and Manage Plan APIs", "type": "object", "example": { "plan_currency": "INR", "plan_id": "144436-03471-JD_TEST", "plan_interval_type": "WEEK", "plan_intervals": 1, "plan_max_amount": 1, "plan_max_cycles": 4, "plan_name": "abscede", "plan_note": "lsdkdn", "plan_recurring_amount": 1, "plan_status": "ACTIVE", "plan_type": "PERIODIC" }, "properties": { "plan_currency": { "type": "string", "description": "Currency for the plan." }, "plan_id": { "type": "string", "description": "Plan ID provided by merchant." }, "plan_interval_type": { "type": "string", "description": "Interval type for the plan." }, "plan_intervals": { "type": "integer", "description": "Number of intervals for the plan." }, "plan_max_amount": { "type": "number", "format": "float64", "description": "Maximum amount for the plan." }, "plan_max_cycles": { "type": "integer", "description": "Maximum number of payment cycles for the plan." }, "plan_name": { "type": "string", "description": "Name of the plan." }, "plan_note": { "type": "string", "description": "Note for the plan." }, "plan_recurring_amount": { "type": "number", "format": "float64", "description": "Recurring amount for the plan." }, "plan_status": { "type": "string", "description": "Status of the plan." }, "plan_type": { "type": "string", "description": "Type of the plan." } } }, "SubscriptionEntity": { "title": "SubscriptionEntity", "description": "The response returned for Get, Create or Manage Subscription APIs.", "type": "object", "example": { "authorisation_details": { "authorization_amount": 1, "authorization_amount_refund": false, "authorization_reference": "", "authorization_time": "2022-06-14T23:47:52+05:30", "authorization_status": "INITIALIZED", "payment_id": "97877", "payment_method": "NPCI_SBC" }, "cf_subscription_id": "4", "customer_details": { "customer_name": "Test Cust", "customer_email": "test@gmail.com", "customer_phone": "9900755700", "customer_bank_account_holder_name": "", "customer_bank_account_number": "", "customer_bank_ifsc": "", "customer_bank_code": "", "customer_bank_account_type": "" }, "plan_details": { "plan_id": "od-20k-plan", "plan_name": "On demand plan for 20000 max amount", "plan_type": "ON_DEMAND", "plan_max_cycles": 0, "plan_recurring_amount": 0, "plan_max_amount": 20000, "plan_interval_type": "", "plan_intervals": 0, "plan_currency": "INR", "plan_note": "", "plan_status": "" }, "subscription_expiry_time": "2100-01-01T05:29:59+05:30", "subscription_first_charge_time": "", "subscription_id": "SUB0028", "subscription_meta": { "return_url": "" }, "subscription_note": "", "subscription_session_id": "subs_token_tc9JCN4MzUIJ", "subscription_payment_splits": null, "subscription_status": "INITIALIZED", "subscription_tags": null }, "properties": { "authorisation_details": { "$ref": "#/components/schemas/AuthorizationDetails" }, "cf_subscription_id": { "type": "string", "description": "Cashfree subscription reference number" }, "customer_details": { "$ref": "#/components/schemas/SubscriptionCustomerDetails" }, "plan_details": { "$ref": "#/components/schemas/PlanEntity" }, "subscription_expiry_time": { "type": "string", "description": "Time at which the subscription will expire." }, "subscription_first_charge_time": { "type": "string", "description": "Time at which the first charge will be made for the subscription. Applicable only for PERIODIC plans." }, "subscription_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the subscription." }, "subscription_meta": { "type": "object", "description": "Subscription metadata.", "properties": { "return_url": { "type": "string", "description": "Return URL for the subscription." } } }, "subscription_note": { "type": "string", "description": "Note for the subscription." }, "subscription_session_id": { "type": "string", "description": "Subscription Session Id." }, "subscription_payment_splits": { "type": "array", "description": "Payment splits for the subscription.", "items": { "$ref": "#/components/schemas/SubscriptionPaymentSplitItem" } }, "subscription_status": { "type": "string", "description": "Status of the subscription." }, "subscription_tags": { "type": "object", "description": "Tags for the subscription." } } }, "SubscriptionPaymentEntity": { "title": "SubscriptionPaymentEntity", "description": "The response returned in Get, Create or Manage Subscription Payment APIs.", "type": "object", "example": { "authorization_details": { "authorization_amount": 1, "authorization_amount_refund": true, "start_time": "2024-04-18T16:40:00", "authorization_reference": "osduh20ijegaoinfbBjuweod31@upi", "authorization_time": "2024-04-18T16:45:00", "authorization_status": "ACTIVE", "payment_id": "test-payment-id" }, "cf_payment_id": "123456", "cf_txn_id": "123456", "cf_order_id": "123456", "cf_subscription_id": "7891011", "failure_details": { "failure_reason": "" }, "payment_amount": 1, "payment_id": "test-payment-id", "payment_initiated_date": "2024-04-18T22:14:58+0530", "payment_remarks": "authpayment", "payment_schedule_date": "", "payment_status": "SUCCESS", "payment_type": "AUTH", "retry_attempts": 0, "subscription_id": "test-subscription-id" }, "properties": { "authorization_details": { "$ref": "#/components/schemas/AuthorizationDetails" }, "cf_payment_id": { "type": "string", "description": "Cashfree subscription payment reference number" }, "cf_subscription_id": { "type": "string", "description": "Cashfree subscription reference number" }, "cf_txn_id": { "type": "string", "description": "Cashfree subscription payment transaction ID" }, "cf_order_id": { "type": "string", "description": "Cashfree subscription payment order ID" }, "failure_details": { "type": "object", "properties": { "failure_reason": { "type": "string", "description": "Failure reason of the payment if the payment_status is failed." } } }, "payment_amount": { "type": "number", "format": "float64", "description": "The charge amount of the payment." }, "payment_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the transaction." }, "payment_initiated_date": { "type": "string", "description": "The date on which the payment was initiated." }, "payment_remarks": { "type": "string", "description": "Payment remarks." }, "payment_schedule_date": { "type": "string", "description": "The date on which the payment is scheduled to be processed." }, "payment_status": { "type": "string", "description": "Status of the payment." }, "payment_type": { "type": "string", "description": "Payment type. Can be AUTH or CHARGE." }, "retry_attempts": { "type": "integer", "description": "Retry attempts." }, "subscription_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the subscription." } } }, "CreateSubscriptionPaymentResponse": { "title": "CreateSubscriptionPaymentResponse", "description": "The response returned is Create Subscription Auth or Charge APIs.", "type": "object", "example": { "payment_id": "test-paymey", "subscription_id": "Demo_Subscription", "payment_amount": 1, "cf_payment_id": "12345", "payment_method": "upi", "payment_status": "SUCCESS", "payment_type": "AUTH", "action": "custom", "channel\"": "link", "data": { "url": "https://api.cashfree.com/pg/view/gateway/tuOssT3fNV8soG97VSeHca034555-8a65-4aaf-9e67-c9893471af23", "payload": null, "content_type": null, "method": null } }, "properties": { "cf_payment_id": { "type": "string", "description": "Cashfree subscription payment reference number" }, "failure_details": { "type": "object", "properties": { "failure_reason": { "type": "string", "description": "Failure reason of the payment if the payment_status is failed." } } }, "payment_amount": { "type": "number", "format": "float64", "description": "The charge amount of the payment." }, "payment_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the transaction." }, "payment_initiated_date": { "type": "string", "description": "The date on which the payment was initiated." }, "payment_status": { "type": "string", "description": "Status of the payment." }, "payment_type": { "type": "string", "description": "Payment type. Can be AUTH or CHARGE.", "example": "CHARGE" }, "subscription_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the subscription." }, "data": { "type": "object", "description": "Contains a payload for auth app links in case of AUTH. For charge, the payload is empty." }, "payment_method": { "type": "string", "description": "Payment method used for the authorization." } } }, "SubscriptionPaymentRefundEntity": { "title": "SubscriptionPaymentRefundEntity", "description": "Get/Create Subscription Payment Refund Response", "type": "object", "example": { "payment_id": "pay8643", "cf_payment_id": "863782648", "refund_id": "refund2", "cf_refund_id": "ref_212", "refund_amount": 100, "refund_note": "test", "refund_speed": "INSTANT", "refund_status": "INITIATED" }, "properties": { "payment_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the transaction." }, "cf_payment_id": { "type": "string", "description": "Cashfree subscription payment reference number." }, "refund_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the refund." }, "cf_refund_id": { "type": "string", "description": "Cashfree subscription payment refund reference number." }, "refund_amount": { "type": "number", "format": "float64", "description": "The refund amount." }, "refund_note": { "type": "string", "description": "Refund note." }, "refund_speed": { "type": "string", "description": "Refund speed. Can be INSTANT or NORMAL." }, "refund_status": { "type": "string", "description": "Status of the refund." } } }, "CreateSubscriptionRefundRequest": { "title": "CreateSubscriptionRefundRequest", "description": "Request body to create a subscription refund.", "example": { "subscription_id": "test-subs-id", "payment_id": "test-payment-id", "refund_id": "dummy-test-refund-id", "refund_amount": 10, "refund_note": "full refund", "refund_speed": "INSTANT", "cf_payment_id": 1234235 }, "properties": { "cf_payment_id": { "description": "Cashfree subscription payment reference number.", "type": "number", "format": "int64" }, "subscription_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the subscription." }, "payment_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the transaction." }, "refund_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the refund." }, "refund_amount": { "type": "number", "format": "float64", "description": "The amount to be refunded. Can be partial or full amount of the payment." }, "refund_note": { "type": "string", "description": "Refund note." }, "refund_speed": { "type": "string", "description": "Refund speed. Can be INSTANT or STANDARD. UPI supports only STANDARD refunds, Enach and Pnach supports only INSTANT refunds." } }, "required": [ "subscription_id", "refund_id", "refund_amount" ] }, "CreatePlanRequest": { "title": "CreatePlanRequest", "description": "Request body to create a plan.", "example": { "plan_id": "plan_12345", "plan_name": "Plan 12345", "plan_type": "PERIODIC", "plan_currency": "INR", "plan_recurring_amount": 10, "plan_max_amount": 100, "plan_max_cycles": 10, "plan_intervals": 2, "plan_interval_type": "WEEK", "plan_note": "Test Plan" }, "properties": { "plan_id": { "type": "string", "description": "Unique ID to identify the plan. Only alpha-numerics, dot, hyphen and underscore allowed.", "minLength": 1, "maxLength": 40 }, "plan_name": { "type": "string", "description": "Name of the plan.", "minLength": 1, "maxLength": 40 }, "plan_type": { "type": "string", "description": "Type of the plan. Possible values - PERIODIC, ON_DEMAND." }, "plan_currency": { "type": "string", "description": "Currency of the plan." }, "plan_recurring_amount": { "type": "number", "format": "float64", "description": "Recurring amount for the plan. Required for PERIODIC plan_type." }, "plan_max_amount": { "type": "number", "format": "float64", "description": "Maximum amount for the plan." }, "plan_max_cycles": { "type": "integer", "description": "Maximum number of payment cycles for the plan." }, "plan_intervals": { "type": "integer", "description": "Number of billing cycles between charges. For instance, if set to 2 and the interval type is 'week', the service will be billed every 2 weeks. Similarly, if set to 3 and the interval type is 'month', the service will be billed every 3 months. Required for PERIODIC plan_type." }, "plan_interval_type": { "type": "string", "description": "Interval type for the plan. Possible values - DAY, WEEK, MONTH, YEAR." }, "plan_note": { "type": "string", "description": "Note for the plan." } }, "required": [ "plan_id", "plan_name", "plan_type", "plan_max_amount" ] }, "ManageSubscriptionRequest": { "title": "ManageSubscriptionRequest", "description": "Request body to manage a subscription.", "example": { "subscription_id": "Demo_Subscription", "action": "CHANGE_PLAN", "action_details": { "plan_id": "new-plan-1" } }, "properties": { "subscription_id": { "type": "string", "description": "The unique ID which was used to create subscription." }, "action": { "type": "string", "description": "Action to be performed on the subscription. Possible values - CANCEL, PAUSE, ACTIVATE, CHANGE_PLAN." }, "action_details": { "type": "object", "description": "Details of the action to be performed.", "properties": { "next_scheduled_time": { "type": "string", "description": "Next scheduled time for the action. Required for ACTIVATE action." }, "plan_id": { "type": "string", "description": "Plan ID to update. Required for CHANGE_PLAN action." } } } }, "required": [ "subscription_id", "action" ] }, "CreateSubscriptionRequest": { "title": "CreateSubscriptionRequest", "description": "Request body to create a new subscription.", "example": { "subscription_id": "Demo_Subscription", "customer_details": { "customer_name": "john", "customer_email": "john@dummy.com", "customer_phone": "9908730221", "customer_bank_account_number": "59108290701802", "customer_bank_ifsc": "HDFC0002614", "customer_bank_code": "HDFC", "customer_bank_account_type": "SAVINGS" }, "plan_details": { "plan_name": "plan12345", "plan_type": "PERIODIC", "plan_amount": 10, "plan_max_amount": 100, "plan_max_cycles": 100, "plan_intervals": 2, "plan_interval_type": "WEEK", "plan_note": "Bi-weekly INR 10 plan" }, "authorization_details": { "authorization_amount": 100, "authorization_amount_refund": true, "payment_methods": [ "enach", "pnach", "upi", "card" ] }, "subscription_meta": { "return_url": "https://wa.me/9512440440?text=Payment%20Successfull", "notification_channel": [ "EMAIL", "SMS" ] }, "subscription_expiry_time": "2024-01-14T23:00:08+05:30", "subscription_first_charge_time": "2024-01-10T23:00:08+05:30", "subscription_note": "testSUB", "subscription_tags": { "key1": "value1", "key2": "value2" }, "subscription_payment_splits": [ { "vendor_id": "vendor1", "amount": 100, "percentage": 10 }, { "vendor_id": "vendor2", "amount": 100, "percentage": 10 } ] }, "properties": { "subscription_id": { "type": "string", "description": "A unique ID for the subscription. It can include alphanumeric characters, underscore, dot, hyphen, and space. Maximum characters allowed is 250.", "minLength": 1, "maxLength": 250 }, "customer_details": { "$ref": "#/components/schemas/SubscriptionCustomerDetails" }, "plan_details": { "type": "object", "properties": { "plan_id": { "type": "string", "description": "The unique identifier used to create plan. You only need to pass this field if you had already created plan. Otherwise use the other fields here to define the plan." }, "plan_name": { "type": "string", "description": "Specify plan name for easy reference.", "maxLength": 40 }, "plan_type": { "type": "string", "description": "Possible values ON_DEMAND or PERIODIC. PERIODIC - Payments are triggered automatically at fixed intervals defined by the merchant. ON_DEMAND - Merchant needs to trigger/charge the customer explicitly with the required amount." }, "plan_currency": { "type": "string", "description": "INR by default." }, "plan_amount": { "type": "number", "format": "float64", "description": "The amount to be charged for PERIODIC plan. This is a conditional parameter, only required for PERIODIC plans." }, "plan_max_amount": { "type": "number", "format": "float64", "description": "This is the maximum amount that can be charged on a subscription." }, "plan_max_cycles": { "type": "integer", "description": "Maximum number of debits set for the plan. The subscription will automatically change to COMPLETED status once this limit is reached." }, "plan_intervals": { "type": "integer", "description": "Number of intervals of intervalType between every subscription payment. For example, to charge a customer bi-weekly use intervalType as “week” and intervals as 2. Required for PERIODIC plan. The default value is 1." }, "plan_interval_type": { "type": "string", "description": "The type of interval for a PERIODIC plan like DAY, WEEK, MONTH, or YEAR. This is a conditional parameter only applicable for PERIODIC plans." }, "plan_note": { "type": "string", "description": "Note for the plan." } } }, "authorization_details": { "type": "object", "properties": { "authorization_amount": { "type": "number", "format": "float64", "description": "Authorization amount for the auth payment." }, "authorization_amount_refund": { "type": "boolean", "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." }, "payment_methods": { "type": "array", "description": "Payment methods for the subscription. enach, pnach, upi, card are possible values.", "items": { "type": "string" } } } }, "subscription_meta": { "type": "object", "properties": { "return_url": { "type": "string", "description": "The url to redirect after checkout." }, "notification_channel": { "type": "array", "description": "Notification channel for the subscription. SMS, EMAIL are possible values.", "items": { "type": "string" } } } }, "subscription_expiry_time": { "type": "string", "description": "Expiry date for the subscription." }, "subscription_first_charge_time": { "type": "string", "description": "Time at which the first charge will be made for the subscription after authorization. Applicable only for PERIODIC plans." }, "subscription_note": { "type": "string", "description": "Note for the subscription." }, "subscription_tags": { "type": "object", "description": "Tags for the subscription." }, "subscription_payment_splits": { "type": "array", "description": "Payment splits for the subscription.", "items": { "$ref": "#/components/schemas/SubscriptionPaymentSplitItem" } } }, "required": [ "subscription_id", "customer_details", "plan_details" ] }, "ManageSubscriptionPaymentRequest": { "title": "ManageSubscriptionPaymentRequest", "description": "Request body to manage a subscription payment.", "example": { "payment_id": "Demo_Payment", "action": "RETRY", "action_details": { "next_scheduled_time": "2024-01-10T23:00:08+05:30" } }, "properties": { "subscription_id": { "type": "string", "description": "The unique ID which was used to create subscription." }, "payment_id": { "type": "string", "description": "The unique ID which was used to create payment." }, "action": { "type": "string", "description": "Action to be performed on the payment. Possible values - CANCEL, RETRY." }, "action_details": { "type": "object", "description": "Details of the action to be performed. Needed for retry action.", "properties": { "next_scheduled_time": { "type": "string", "description": "Next scheduled time for the retry of the FAILED payment. Required for retry action." } } } }, "required": [ "subscription_id", "payment_id", "action" ] }, "CreateSubscriptionPaymentRequest": { "title": "CreateSubscriptionPaymentRequest", "description": "The request to be passed for the create subscription payment API.", "properties": { "subscription_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the subscription." }, "subscription_session_id": { "type": "string", "description": "Session ID for the subscription. Required only for Auth." }, "payment_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the subscription payment." }, "payment_amount": { "type": "number", "format": "float64", "description": "The charge amount of the payment. Required in case of charge." }, "payment_schedule_date": { "type": "string", "description": "The date on which the payment is scheduled to be processed. Required for UPI and CARD payment modes." }, "payment_remarks": { "type": "string", "description": "Payment remarks." }, "payment_type": { "type": "string", "description": "Payment type. Can be AUTH or CHARGE." }, "payment_method": { "type": "object", "description": "Payment method. Can be one of [\"upi\", \"enach\", \"pnach\", \"card\"]", "oneOf": [ { "$ref": "#/components/schemas/CreateSubscriptonPaymentRequestUpi" }, { "$ref": "#/components/schemas/CreateSubscriptionPaymentRequestEnach" }, { "$ref": "#/components/schemas/CreateSubscriptionPaymentRequestPnach" }, { "$ref": "#/components/schemas/CreateSubscriptionPaymentRequestCard" } ] } }, "required": [ "subscription_id", "payment_id", "payment_type" ] }, "CreateSubscriptonPaymentRequestUpi": { "description": "payment method upi.", "properties": { "channel": { "description": "Channel. can be link, qrcode, or collect", "type": "string" }, "upi_id": { "type": "string" } }, "title": "CreateSubscriptonPaymentRequestUpi", "type": "object" }, "CreateSubscriptionPaymentRequestCard": { "description": "payment method card.", "properties": { "card_cvv": { "description": "Card CVV", "type": "string" }, "card_expiry_mm": { "description": "Card expiry month", "type": "string" }, "card_expiry_yy": { "description": "Card expiry year", "type": "string" }, "card_holder_name": { "description": "Card holder name", "type": "string" }, "card_network": { "description": "Card network", "type": "string" }, "card_number": { "description": "Card number", "type": "string" }, "card_type": { "description": "Card type", "type": "string" }, "channel": { "description": "Channel. can be link", "type": "string" } }, "title": "CreateSubscriptionPaymentRequestCard", "type": "object" }, "CreateSubscriptionPaymentRequestEnach": { "description": "payment method enach.", "properties": { "account_bank_code": { "description": "Account bank code (required without AccountIFSC)", "type": "string" }, "account_holder_name": { "description": "Account holder name", "type": "string" }, "account_ifsc": { "description": "Account IFSC", "type": "string" }, "account_number": { "description": "Account number", "type": "string" }, "account_type": { "description": "Account type", "type": "string" }, "auth_mode": { "description": "Authentication mode. can be debit_card, aadhaar, or net_banking", "type": "string" }, "channel": { "description": "Channel. can be link", "type": "string" } }, "title": "CreateSubscriptionPaymentRequestEnach", "type": "object" }, "CreateSubscriptionPaymentRequestPnach": { "description": "payment method pnach.", "properties": { "account_bank_code": { "description": "Account bank code", "type": "string" }, "account_holder_name": { "description": "Account holder name", "type": "string" }, "account_ifsc": { "description": "Account IFSC", "type": "string" }, "account_number": { "description": "Account number", "type": "string" }, "account_type": { "description": "Account type", "type": "string" }, "channel": { "description": "Channel. can be post", "type": "string" }, "mandate_creation_date": { "description": "Mandate creation date", "type": "string" }, "mandate_start_date": { "description": "Mandate start date", "type": "string" } }, "title": "CreateSubscriptionPaymentRequestPnach", "type": "object" }, "UploadPnachImageRequest": { "title": "UploadPnachImageRequest", "description": "Request Body to upload Physical Nach Image.", "properties": { "file": { "type": "string", "format": "binary", "description": "Select the .jpg file that should be uploaded or provide the path of that file. You cannot upload a file that is more than 1MB in size." }, "payment_id": { "type": "string", "description": "Authorization Payment ID for physical nach authorization" }, "action": { "type": "string", "description": "Action to be performed on the file. Can be SUBMIT_DOCUMENT" } }, "required": [ "action", "payment_id", "file" ] }, "UploadPnachImageResponse": { "title": "UploadPnachImageResponse", "description": "Response of pnach image upload API.", "properties": { "payment_id": { "type": "string", "description": "The payment_id against which the pnach image is uploaded." }, "authorization_status": { "type": "string", "description": "Authorization status of the subscription." }, "action": { "type": "string", "description": "Action performed on the file." }, "payment_message": { "type": "string", "description": "Message of the API." } } }, "SubscriptionEligibilityRequest": { "title": "SubscriptionEligibilityRequest", "description": "Request body to fetch subscription eligibile payment method details.", "properties": { "queries": { "type": "object", "description": "Necessary parameters to fetch eligible payment methods.", "properties": { "subscription_id": { "type": "string", "description": "A unique ID passed by merchant for identifying the subscription" } }, "required": [ "subscription_id" ] }, "filters": { "type": "object", "description": "Filters to refine eligible payment method selection.", "properties": { "payment_methods": { "type": "array", "description": "Possbile values in array - enach, pnach, upi, card.", "items": { "type": "string" } } } } }, "required": [ "queries" ] }, "SubscriptionBankDetails": { "type": "object", "description": "Bank details object", "properties": { "bank_id": { "type": "string", "description": "ID of the bank." }, "bank_name": { "type": "string", "description": "Name of the bank." }, "account_auth_modes": { "type": "array", "items": { "type": "string" }, "description": "List of account authentication modes supported by the bank. (e.g. DEBIT_CARD, NET_BANKING, AADHAAR)" } } }, "EligibilityMethodItem": { "title": "EligibilityMethodItem", "description": "Eligibile payment method object", "properties": { "eligibility": { "type": "boolean", "description": "Indicates whether the payment method is eligible." }, "entity_type": { "type": "string", "description": "Type of entity (e.g., \"payment_methods\")." }, "entity_value": { "type": "string", "description": "Payment method (e.g., enach, pnach, upi, card)." }, "entity_details": { "type": "object", "properties": { "account_types": { "type": "array", "items": { "type": "string" }, "description": "List of account types associated with the payment method. (e.g. SAVINGS or CURRENT)" }, "frequent_bank_details": { "type": "array", "description": "List of the most frequently used banks.", "items": { "$ref": "#/components/schemas/SubscriptionBankDetails" } }, "all_bank_details": { "type": "array", "description": "Details about all banks associated with the payment method.", "items": { "$ref": "#/components/schemas/SubscriptionBankDetails" } }, "available_handles": { "type": "array", "description": "List of supported VPA handles.", "items": { "type": "object", "properties": { "handle": { "type": "string", "description": "VPA handle" }, "application": { "type": "string", "description": "Application or service related to the VPA handle." } } } }, "allowed_card_types": { "type": "array", "description": "List of allowed card types. (e.g. DEBIT_CARD, CREDIT_CARD)", "items": { "type": "string", "description": "List of allowed card types associated with the payment method." } } } } } }, "SubscriptionEligibilityResponse": { "title": "SubscriptionEligibilityResponse", "description": "Subscrition eligibility API response", "properties": { "type": { "type": "array", "description": "List of eligibile payment methods for the subscription.", "items": { "$ref": "#/components/schemas/EligibilityMethodItem" } } } }, "PARRequest": { "type": "object", "properties": { "card_number": { "type": "string", "description": "The card number, containing 15 to 19 numeric digits without spaces or special characters.", "example": "xxxx...xxx" }, "card_cvv": { "type": "string", "description": "The Card Verification Value (CVV), a 3-digit code for most cards (Visa, Mastercard) and a 4-digit code for American Express, used for transaction authentication.", "example": "xxx" }, "card_expiry_mm": { "type": "string", "description": "The two-digit expiry month (01-12), indicating when the card will expire.", "example": "xx" }, "card_expiry_yy": { "type": "string", "description": "The two-digit expiry year, representing the last two digits of the card’s expiration year.", "example": "xx" }, "card_type": { "type": "string", "description": "Specifies the type of card, with the only accepted value being `PLAIN_CARD`.", "enum": [ "PLAIN_CARD" ], "example": "PLAIN_CARD" } }, "required": [ "card_number", "card_cvv", "card_expiry_mm", "card_expiry_yy", "card_type" ] } }, "parameters": { "apiVersionHeader": { "in": "header", "name": "x-api-version", "description": "API version to be used. Format is in YYYY-MM-DD", "schema": { "type": "string", "description": "API version to be used", "default": "2025-01-01" }, "example": "2025-01-01", "x-ignore": true }, "cfPaymentIDParam": { "name": "cf_payment_id", "in": "path", "required": true, "description": "The Cashfree payment or transaction ID.", "schema": { "type": "string" }, "example": "121224562" }, "customerIDParam": { "name": "customer_id", "in": "path", "required": true, "description": "Your Customer ID that you had sent during create order API `POST/orders`", "schema": { "type": "string" }, "example": "your-customer-id" }, "linkIDParam": { "name": "link_id", "in": "path", "required": true, "description": "The payment link ID for which you want to view the details.", "schema": { "type": "string" }, "example": "your-link-id" }, "statusQueryParam": { "name": "status", "in": "query", "required": false, "description": "Mention What is status of orders you want to fetch, default is PAID. Possible value: ALL, PAID", "schema": { "type": "string" }, "example": "ALL" }, "orderIDParam": { "name": "order_id", "in": "path", "required": true, "description": "The id which uniquely identifies your order", "schema": { "type": "string" }, "example": "your-order-id" }, "vendorIDParam": { "name": "vendor_id", "in": "path", "required": true, "description": "The id which uniquely identifies your vendor.", "schema": { "type": "string" }, "example": "your-vendor-id" }, "amountParam": { "name": "amount", "in": "path", "required": true, "description": "Specify the amount for which you want to view the service charges and service taxes in the response.", "schema": { "type": "number", "format": "float64" }, "example": 1000 }, "rateTypeParam": { "name": "rate_type", "in": "query", "required": true, "description": "Mention the type of rate for which you want to check the charges. Possible value: VENDOR_ON_DEMAND", "schema": { "type": "string" }, "example": "VENDOR_ON_DEMAND" }, "docTypeParam": { "name": "doc_type", "in": "path", "required": true, "description": "Mention the document type that has to be downloaded. Only an uploaded document can be downloaded.", "schema": { "type": "string" } }, "xIdempotencyKeyHeader": { "in": "header", "name": "x-idempotency-key", "required": false, "description": "An idempotency key is a unique identifier in your API call. If the request fails or times out, you can retry it with the same key to prevent duplicate actions.\n", "schema": { "type": "string", "format": "UUID" }, "example": "47bf8872-46fe-11ee-be56-0242ac120002" }, "xRequestIDHeader": { "in": "header", "name": "x-request-id", "description": "Request ID for the API call. It can be used to resolve technical issues. Include this in your tech-related queries to Cashfree.", "required": false, "schema": { "type": "string" }, "example": "4dfb9780-46fe-11ee-be56-0242ac120002" }, "planIdParam": { "name": "plan_id", "in": "path", "example": "plan-id-123", "required": true, "description": "Provide the PlanId for which the details have to be fetched.", "schema": { "type": "string" } }, "subscriptionIdParam": { "name": "subscription_id", "in": "path", "example": "subscription-id-123", "required": true, "description": "Provide the SubscriptionId using which the subscription was created.", "schema": { "type": "string" } }, "subscriptionPaymentIdParam": { "name": "payment_id", "in": "path", "example": "payment-id-123", "required": true, "description": "Provide the PaymentId using which the payment was created.", "schema": { "type": "string" } }, "subscriptionRefundIdParam": { "name": "refund_id", "in": "path", "example": "refund-id-123", "required": true, "description": "Provide the PaymentId for which the details have to be fetched.", "schema": { "type": "string" } } }, "requestBodies": { "VendorReconRequest": { "description": "Vendor Recon Request body.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorReconRequest" } } } }, "AuthorizeOrderRequest": { "description": "Request to Capture or Void Transactions", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeOrderRequest" } } } }, "CreateCustomerRequest": { "description": "Request to create a new customer at Cashfree", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" }, "examples": { "create_customer": { "$ref": "#/components/examples/create_customer" } } } } }, "CreateLinkRequest": { "description": "Request Body to Create Payment Links", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLinkRequest" } } } }, "SimulateRequest": { "description": "Request Body to Make Simulation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulateRequest" }, "examples": { "payment_failure_simulation": { "value": { "entity": "PAYMENTS", "entity_id": "14934289844", "entity_simulation": { "payment_status": "FAILED", "payment_error_code": "ISSUER_NOT_AVAILABLE" } } }, "subscription_payment_success_simulation": { "value": { "entity": "SUBS_PAYMENTS", "entity_id": "9881282748", "entity_simulation": { "payment_status": "SUCCESS", "payment_error_code": "" } } } } } } }, "CreateOfferRequest": { "description": "Request body to create an offer at Cashfree", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOfferRequest" }, "examples": { "card_offer": { "$ref": "#/components/examples/card_offer" }, "net_banking_offer": { "$ref": "#/components/examples/net_banking_offer" }, "emi_offer": { "$ref": "#/components/examples/no_cost_emi_offer" } } } } }, "CreateOrderRequest": { "description": "Request body to create an order at cashfree", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequest" }, "examples": { "order_minimum": { "$ref": "#/components/examples/order_minimum" }, "order_orderid": { "$ref": "#/components/examples/order_orderid" }, "order_customer": { "$ref": "#/components/examples/order_customer" }, "order_with_return_url": { "$ref": "#/components/examples/order_with_return_url" }, "order_with_payment_methods": { "$ref": "#/components/examples/order_with_payment_methods" }, "order_expiry": { "$ref": "#/components/examples/order_expiry" }, "order_note": { "$ref": "#/components/examples/order_note" }, "order_tags": { "$ref": "#/components/examples/order_tags" }, "order_splits_amount": { "$ref": "#/components/examples/order_splits_amount" }, "order_splits_cent": { "$ref": "#/components/examples/order_splits_cent" }, "order_invoice": { "$ref": "#/components/examples/order_invoice" }, "order_customer_tpv": { "$ref": "#/components/examples/order_customer_tpv" } } } } }, "UpdateOrderExtendedRequest": { "description": "Request Body to Update extended data related to order", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderExtendedRequest" }, "examples": { "order_extended_minimum": { "$ref": "#/components/examples/order_extended_minimum" }, "order_extended_delivery_status": { "$ref": "#/components/examples/order_extended_delivery_status" }, "order_extended_all_field": { "$ref": "#/components/examples/order_extended_all_field" } } } } }, "CreateTerminalRequest": { "description": "Request Body to Create Terminal for SPOS", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTerminalRequest" } } } }, "CreateTerminalTransactionRequest": { "description": "Request body to create a terminal transaction", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTerminalTransactionRequest" } } } }, "EligibilityFetchCardlessEMIRequest": { "description": "Request Body to get eligible cardless emi options for a customer and order", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityFetchCardlessEMIRequest" }, "examples": { "eligibility_cardless_emi": { "$ref": "#/components/examples/eligibility_cardless_emi" } } } } }, "EligibilityFetchOffersRequest": { "description": "Request Body to get eligible offers for a customer and order", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityFetchOffersRequest" }, "examples": { "offers": { "$ref": "#/components/examples/eligible_offers" }, "no_cost_emi_offers": { "$ref": "#/components/examples/eligible_no_cost_emi_offers" } } } } }, "EligibilityFetchPaylaterRequest": { "description": "Request Body to get eligible paylater options for a customer and order", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityFetchPaylaterRequest" }, "examples": { "eligible_paylater": { "$ref": "#/components/examples/eligible_paylater" } } } } }, "EligibilityFetchPaymentMethodsRequest": { "description": "Request Body to get eligible payment methods for an account and order", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityFetchPaymentMethodsRequest" }, "examples": { "eligible_all_payment_methods_nb": { "$ref": "#/components/examples/eligible_all_payment_methods" }, "eligible_card_payment_methods_nb": { "$ref": "#/components/examples/eligible_card_payment_methods" }, "eligible_netbanking_payment_methods": { "$ref": "#/components/examples/eligible_netbanking_payment_methods" } } } } }, "FetchReconRequest": { "description": "Request Body for the reconciliation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchReconRequest" } } } }, "FetchSettlementsRequest": { "description": "Request Body to get the settlements", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchSettlementsRequest" } } } }, "OrderAuthenticatePaymentRequest": { "description": "Request body to submit/resend headless OTP. To use this API make sure you have headless OTP enabled for your account", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAuthenticatePaymentRequest" } } } }, "OrderCreateRefundRequest": { "description": "Request Body to Create Refunds", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateRefundRequest" } } } }, "PayOrderRequest": { "description": "Request body to create a transaction at cashfree using `payment_session_id`", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayOrderRequest" }, "examples": { "issuer_guest_checkout_token_number": { "$ref": "#/components/examples/issuer_guest_checkout_token_number" }, "issuer_token_number": { "$ref": "#/components/examples/issuer_token_number" }, "network_guest_checkout_token_number": { "$ref": "#/components/examples/network_guest_checkout_token_number" }, "plain_card": { "$ref": "#/components/examples/plain_card" }, "save_card_during_payment": { "$ref": "#/components/examples/save_card_during_payment" }, "saved_card": { "$ref": "#/components/examples/saved_card" }, "token_card": { "$ref": "#/components/examples/token_card" }, "pay_upi_intent": { "$ref": "#/components/examples/pay_upi_intent" }, "pay_upi_collect": { "$ref": "#/components/examples/pay_upi_collect" }, "pay_netbanking": { "$ref": "#/components/examples/pay_netbanking" }, "pay_netbanking_code": { "$ref": "#/components/examples/pay_netbanking_code" }, "pay_ccemi": { "$ref": "#/components/examples/pay_ccemi" }, "pay_wallet_app": { "$ref": "#/components/examples/pay_wallet_app" }, "pay_upi_collect_redirect": { "$ref": "#/components/examples/pay_upi_collect_redirect" }, "pay_upi_qr": { "$ref": "#/components/examples/pay_upi_qr" }, "pay_card_headless": { "$ref": "#/components/examples/pay_card_headless" } } } } }, "SettlementFetchReconRequest": { "description": "Request Body for the settlement reconciliation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementFetchReconRequest" } } } }, "CreateOrderSettlementRequestBody": { "description": "Create Order Settlement Request Body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderSettlementRequestBody" }, "example": { "order_id": "order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H", "meta_data": { "cbriks_id": "CBRIKS_004", "settlement_date": "2024-04-12" } } } } }, "CreateVendorRequestBody": { "description": "Create Vendor Request Body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVendorRequest" }, "examples": { "PG - Bank Account": { "value": { "vendor_id": "vendortest123", "status": "ACTIVE", "name": "customer", "email": "johndoe@cashfree.com", "phone": 9876543210, "verify_account": true, "dashboard_access": true, "schedule_option": 1, "bank": { "account_number": 12345678890, "account_holder": "John Doe", "ifsc": "HDFC019345" }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "uidai": 753624181019, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000", "pan": "BIAPA2934N", "passport_number": "L6892603" } } }, "PG - UPI": { "value": { "vendor_id": "vendortest123", "status": "ACTIVE", "name": "customer", "email": "johndoe@cashfree.com", "phone": 9876543210, "verify_account": true, "dashboard_access": true, "schedule_option": 1, "upi": { "vpa": "success@upi", "account_holder": "JOHN DOE" }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "uidai": 753624181019, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000", "pan": "BIAPA2934N", "passport_number": "L6892603" } } }, "PG - Auto Collect": { "value": { "vendor_id": "devtest23", "name": "customer", "email": "johndoe@cashfree.com", "phone": 9876543454, "verify_account": false, "dashboard_access": true, "bank": { "account_number": 26291800001191, "account_holder": "John Doe", "ifsc": "YESB0000262" }, "kyc_details": { "account_type": "INDIVIDUAL", "business_type": "NBFC", "uidai": 456712345678, "pan": "AFDHK1234F" } } } } } } }, "StaticSplitRequestBody": { "description": "Static Split", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticSplitRequest" }, "examples": { "PG": { "value": { "active": true, "terminal_id": 0, "product_type": "PG", "scheme": [ { "merchant_vendor_id": "EsTest1Success", "percentage": 10 } ] } }, "Subscriptions": { "value": { "active": true, "terminal_id": 152718, "product_type": "SBC", "scheme": [ { "merchant_vendor_id": "da15", "percentage": 10 }, { "merchant_vendor_id": "vsinte1", "percentage": 10 } ] } } } } } }, "ESOrderReconRequestBody": { "description": "Get Split and Settlement Details by OrderID v2.0", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESOrderReconRequest" }, "example": { "filters": { "start_date": null, "end_date": null, "order_ids": [ "order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X" ] } } } } }, "SplitAfterPaymentRequestBody": { "description": "Request Body to Create Split for an order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitAfterPaymentRequest" }, "examples": { "PG": { "value": { "split": [ { "vendor_id": "test03", "percentage": 10, "tags": { "product": "Dri-Fit trouser", "size": "L", "AWB": "NIKE12334" } } ], "disable_split": true } }, "Auto Collect": { "value": { "split": [ { "vendorId": "Vendor001", "percentage": 10 } ], "disable_split": true } } } } } }, "AdjustVendorBalanceRequestBody": { "description": "Adjust Vendor Balance Request Body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustVendorBalanceRequest" }, "examples": { "PG": { "value": { "transfer_from": "VENDOR", "transfer_type": "ADJUSTMENT", "transfer_amount": 10, "remark": "Testing", "tags": { "size": 1, "product": "SHRT" } } } } } } }, "UpdateVendorRequestBody": { "description": "Create Vendor Request Body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVendorRequest" }, "examples": { "PG - Bank Account": { "value": { "status": "ACTIVE", "name": "customer", "email": "johndoe@cashfree.com", "phone": 9876543210, "verify_account": true, "dashboard_access": true, "schedule_option": 1, "bank": { "account_number": 12345678890, "account_holder": "John Doe", "ifsc": "HDFC019345" }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "uidai": 753624181019, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000", "pan": "BIAPA2934N", "passport_number": "L6892603" } } }, "PG - UPI": { "value": { "status": "ACTIVE", "name": "customer", "email": "johndoe@cashfree.com", "phone": 9876543210, "verify_account": true, "dashboard_access": true, "schedule_option": 1, "upi": { "vpa": "success@upi", "account_holder": "JOHN DOE" }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "uidai": 753624181019, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000", "pan": "BIAPA2934N", "passport_number": "L6892603" } } }, "PG - Auto Collect": { "value": { "name": "john", "email": "john.s@cashfree.com", "phone": 9600176784, "upi": { "vpa": "number@paytm", "account_holder": "holder" }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "uidai": 753624181019, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000", "pan": "BIAPA2934N", "passport_number": "L6892603" } } } } } } }, "VendorAdjustmentRequestBody": { "description": "Vendor Adjustment Request Body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorAdjustmentRequest" }, "examples": { "PG": { "value": { "vendor_id": "test_123", "adjustment_id": 1234567, "amount": 10, "type": "CREDIT", "remarks": "Testing" } } } } } }, "UpdateTerminalRequest": { "description": "Request Body to update terminal for SPOS.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTerminalRequest" } } } }, "UpdateTerminalStatusRequest": { "description": "Request Body to update terminal status for SPOS.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTerminalStatusRequest" } } } }, "UploadTerminalDocs": { "description": "Request Body to update terminal documents for SPOS.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadTerminalDocs" } } } }, "TerminateOrderRequest": { "description": "Request body to terminate an order at cashfree", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminateOrderRequest" } } } }, "CreateSubscriptionRequest": { "description": "Request body to create a subscription.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRequest" } } } }, "ManageSubscriptionRequest": { "description": "Request body to manage a subscription.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageSubscriptionRequest" } } } }, "CreatePlanRequest": { "description": "Request body to create a plan.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePlanRequest" } } } }, "CreateSubscriptionPaymentRequest": { "description": "Request body to create a subscription payment.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionPaymentRequest" }, "examples": { "create_subscription_charge": { "$ref": "#/components/examples/create_subscription_charge" }, "create_subscription_auth": { "$ref": "#/components/examples/create_subscription_auth" } } } } }, "UploadPnachImageRequest": { "description": "Request Body to upload Physical Nach Image.", "required": true, "content": { "multipart/form-data": { "schema": { "title": "UploadPnachImageRequest", "description": "Request Body to upload Physical Nach Image.", "properties": { "file": { "type": "string", "format": "binary", "description": "Select the .jpg file that should be uploaded or provide the path of that file. You cannot upload a file that is more than 1MB in size." }, "payment_id": { "type": "string", "description": "Authorization Payment ID for physical nach authorization" }, "action": { "type": "string", "description": "Action to be performed on the file. Can be SUBMIT_DOCUMENT" } }, "required": [ "action", "payment_id", "file" ] }, "examples": { "Physical Nach Image": { "value": { "action": "UPLOAD", "file": "@'/Users/john/Downloads/pan.jpeg'", "payment_id": "payment-1234" } } } } } }, "SubscriptionEligibilityRequest": { "description": "Request body to fetch subscription eligibile payment method details.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionEligibilityRequest" }, "examples": { "no filters": { "value": { "queries": { "subscription_id": "test-subscription-1" }, "filters": { "payment_methods": [] } } }, "upi and enach filter": { "value": { "queries": { "subscription_id": "test-subscription-1" }, "filters": { "payment_methods": [ "upi", "enach" ] } } } } } } }, "CreateSubscriptionRefundRequest": { "description": "Request body to create a subscription refund.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRefundRequest" } } } }, "ManageSubscriptionPaymentRequest": { "description": "Request body to manage a subscription payment.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageSubscriptionPaymentRequest" } } } }, "PARRequest": { "description": "Request payload for creating PAR.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PARRequest" } } } } }, "responses": { "Response400VendorRecon": { "description": "Vendor Recon Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Minimum pagination limit": { "value": { "message": "pagination.limit : should be at least 10", "code": "pagination.limit_invalid", "type": "invalid_request_error" } }, "Maximum pagination limit": { "value": { "message": "pagination.limit : should be at max 1000", "code": "pagination.limit_invalid", "type": "invalid_request_error" } }, "Invalid start or end time format": { "value": { "message": "time should be ISO8601 string. Example 2021-07-02T10:20:12+05:30 for IST, 2021-07-02T10:20:12Z for UTC", "code": "order_expiry_time_invalid", "type": "invalid_request_error" } }, "Start date greater than end date": { "value": { "message": "start date can not be greater than end date", "code": "order_expiry_time_invalid", "type": "invalid_request_error" } }, "Invalid cursor": { "value": { "message": "invalid character '\\n' in literal null (expecting 'l')", "code": "request_failed", "type": "invalid_request_error" } } } } } }, "Response400": { "description": "Bad request error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "Response401": { "description": "Authentication Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "Response404": { "description": "Resource Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError404" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "Response409": { "description": "Resource already present", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError409" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "Response422": { "description": "Idempotency error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdempotencyError" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "Response429": { "description": "Rate Limit Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "Response500": { "description": "API related Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "Response502": { "description": "Bank related Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError502" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "GetVendorBalanceSuccessResponse": { "description": "Get Vendor Balance Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorBalance" }, "examples": { "PG": { "value": { "merchant_id": 152707, "vendor_id": "test03", "merchant_unsettled": 2412, "vendor_unsettled": 0 } } } } } }, "GetVendorBalanceTransferChargesSuccessResponse": { "description": "Get Vendor Balance Transfer Charges Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorBalanceTransferCharges" }, "examples": { "PG": { "value": { "service_charges": 20, "service_tax": 3.6, "amount": 1000, "billed_to": "MERCHANT", "is_postpaid": true } } } } } }, "uploadVendorDocsSuccessResponse": { "description": "Upload Vendor Docs Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadVendorDocumentsResponse" }, "examples": { "PG": { "value": { "vendor_id": "johntest11111", "doc_type": "CIN", "doc_value": "easySplit/vendorKycDocs/152707/93117/CIN-Fue.pdf", "status": "IN_REVIEW", "remarks": null } }, "Auto Collect": { "value": { "vendor_id": "johntest11111", "doc_type": "CIN", "doc_value": "easySplit/vendorKycDocs/152707/93117/CIN-Fue.pdf", "status": "IN_REVIEW", "remarks": null } } } } } }, "StaticSplitSuccessResponse": { "description": "Static Split Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticSplitResponse" }, "examples": { "PG": { "value": { "product_type": "PG", "terminal_id": 0, "terminal_reference_id": null, "active": true, "scheme": [ { "merchant_vendor_id": "EsTest1Success", "percentage": 10 } ], "added_on": "2023-06-08 15:45:46" } }, "Subscription": { "value": { "active": true, "productType": "SBC", "terminalId": 152718, "terminalRefId": null, "scheme": [ { "merchantVendorId": "vsinte1", "amount": null, "percentage": 10, "tags": null }, { "merchantVendorId": "da15", "amount": null, "percentage": 10, "tags": null } ], "addedOn": "2023-07-04 16:44:53" } } } } } }, "ESOrderReconSuccessResponse": { "description": "ES Order Recon Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESOrderReconResponse" }, "examples": { "PG": { "value": { "cursor": null, "data": [ { "amount": 900000, "settlement_eligibility_time": "2024-01-08 11:30:00", "merchant_order_id": "order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X", "tx_time": "2024-01-08 17:00:00", "settled": "NO", "entity_id": "14910180251", "merchant_settlement_utr": "N/A", "currency": "INR", "sale_type": "CREDIT", "customer_name": "Manideep", "customer_email": "manideep.ellur@cashfree.com", "customer_phone": "8281554863", "merchant_vendor_commission": "810000.00", "split_service_charge": "900.00", "split_service_tax": "162.00", "pg_service_tax": "4698.90", "pg_service_charge": "26105.00", "pg_charge_postpaid": "1", "merchant_settlement_id": "N/A", "added_on": "2024-01-08 17:00:00", "tags": "tags", "entity_type": "transaction", "settlement_initiated_on": "N/A", "settlement_time": "N/A", "order_splits": [ { "split": [ { "merchant_vendor_id": "vendor20Lakh", "percentage": 90, "tags": null } ], "created_at": "2024-01-08 17:00:01" } ], "eligible_split_balance": "0.00" }, { "amount": 810000, "merchant_order_id": "order_1527072afd7Hlp4lpVLiz7dj0P0i84r1X", "tx_time": "2024-01-08 17:00:00", "settled": "YES", "entity_id": "305293", "merchant_vendor_id": "vendor20Lakh", "currency": "INR", "sale_type": "CREDIT", "customer_name": "Manideep", "customer_email": "manideep.ellur@cashfree.com", "customer_phone": "8281554863", "added_on": "2024-01-08 17:00:01", "entity_type": "vendor_commission", "past_settlements": [ { "settlement_id": 54878, "settlement_initiated_on": "2024-01-08 17:14:38", "status": "SUCCESS" } ], "vendor_split_service_charges": "0.00", "vendor_split_service_tax": "0.00", "vendor_settlement_time": "2024-01-08 17:14:39", "vendor_settlement_initiated_on": "2024-01-08 17:14:38", "vendor_settlement_eligibility_time": "2024-01-08 16:50:00", "vendor_settlement_id": "54878", "vendor_settlement_utr": "1704714278653975", "vendor_commission": "810000.00", "vendor_pg_service_charge": "0.00", "vendor_pg_service_tax": "0.00", "status": "N/A" } ], "limit": 2 } }, "Auto Collect": { "value": { "message": "Order settlement details", "status": "OK", "orderAmount": 500, "orderSplit": [ { "vendorId": "vendorId1", "amount": 123 }, { "vendorId": "vendorId2", "percentage": 20 }, { "vendorId": "vendorId3", "amount": 150 } ], "serviceCharge": 5, "serviceTax": 0.9, "splitServiceCharge": 7.5, "splitServiceTax": 1.35, "settlementAmount": 112.25, "settlementEligiblityDate": "2022-10-14 15:00:00", "vendors": [ { "id": "vendorId1", "settlementId": 81, "settlementAmount": 123, "settlementEligibilityDate": "2022-10-14 15:00:00" }, { "id": "vendorId2", "settlementId": 82, "settlementAmount": 100, "settlementEligibilityDate": "2022-10-14 15:00:00" }, { "id": "vendorId3", "settlementId": 84, "settlementAmount": 150, "settlementEligibilityDate": "2022-10-14 15:00:00" } ] } } } } } }, "SplitAfterPaymentSuccessResponse": { "description": "Split After Payment Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitAfterPaymentResponse" }, "examples": { "PG": { "value": { "message": "Order split created", "status": "OK" } }, "Auto Collect": { "value": { "message": "Order split created", "status": "OK" } } } } } }, "adjustVendorBalanceSuccessResponse": { "description": "Adjust Vendor Balance Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustVendorBalanceResponse" }, "examples": { "PG": { "value": { "settlement_id": 1050232, "transfer_details": { "vendor_id": "test03", "transfer_from": "VENDOR", "transfer_type": "ON_DEMAND", "transfer_amount": 10, "remark": "Testing", "tags": { "product": "Paneer Tikka", "size": "L", "AWB": "PNRTKKA12334" } }, "balances": { "merchant_id": 152707, "vendor_id": "test03", "merchant_unsettled": 2442, "vendor_unsettled": 4757.42 }, "charges": { "service_charges": 2, "service_tax": 0.36, "amount": 10, "billed_to": "MERCHANT", "is_postpaid": true } } } } } } }, "downloadVendorDocsSuccessResponse": { "description": "Download Vendor Docs Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorDocumentDownloadResponse" }, "examples": { "PG": { "value": { "download_url": "https://cashfreelogo.cashfree.com/cashfree" } }, "Auto Collect": { "value": { "download_url": "https://cashfreelogo.cashfree.com/cashfree" } } } } } }, "getVendorDocsSuccessResponse": { "description": "Get Vendor Docs Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorDocumentsResponse" }, "examples": { "PG": { "value": { "related_docs": [ { "vendor_id": "johntest11111", "doc_type": "CIN_NUMBER", "doc_value": "L00000Aa0000AaA000000", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "GSTIN_NUMBER", "doc_value": "11AAAAA1111A1Z0", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PAN_NUMBER", "doc_value": "BIAPA2934N", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PASSPORT_NUMBER", "doc_value": "L6892603", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "UIDAI_NUMBER", "doc_value": 753624181019, "status": "IN_REVIEW", "remarks": null } ] } }, "Auto Collect": { "value": { "related_docs": [ { "vendor_id": "johntest11111", "doc_type": "CIN_NUMBER", "doc_value": "L00000Aa0000AaA000000", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "GSTIN_NUMBER", "doc_value": "11AAAAA1111A1Z0", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PAN_NUMBER", "doc_value": "BIAPA2934N", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PASSPORT_NUMBER", "doc_value": "L6892603", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "UIDAI_NUMBER", "doc_value": 753624181019, "status": "IN_REVIEW", "remarks": null } ] } } } } } }, "getVendorSuccessResponse": { "description": "Get Vendor Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorEntity" }, "examples": { "PG": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "phone": 9876543210, "name": "customer", "vendor_id": "johntest11111", "added_on": "2023-03-02 12:12:56", "updated_on": "2023-03-02 12:12:57", "bank": { "account_number": 123456111110, "account_holder": "JOHNDOE", "ifsc": "YESB0000262" }, "upi": null, "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": true }, "vendor_type": "PG", "account_type": "BUSINESS", "business_type": "NBFC", "related_docs": [ { "vendor_id": "johntest11111", "doc_type": "CIN_NUMBER", "doc_value": "L00000Aa0000AaA000000", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "GSTIN_NUMBER", "doc_value": "11AAAAA1111A1Z0", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PAN_NUMBER", "doc_value": "BIAPA2934N", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PASSPORT_NUMBER", "doc_value": "L6892603", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "UIDAI_NUMBER", "doc_value": 753624181019, "status": "IN_REVIEW", "remarks": null } ] } }, "Auto Collect": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "phone": 9876543210, "name": "customer", "vendor_id": "johntest11111", "added_on": "2023-03-02 12:12:56", "updated_on": "2023-03-02 12:12:57", "bank": { "account_number": 123456111110, "account_holder": "JOHNDOE", "ifsc": "YESB0000262" }, "upi": null, "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": true }, "vendor_type": "PG", "account_type": "BUSINESS", "business_type": "NBFC", "related_docs": [ { "vendor_id": "johntest11111", "doc_type": "CIN_NUMBER", "doc_value": "L00000Aa0000AaA000000", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "GSTIN_NUMBER", "doc_value": "11AAAAA1111A1Z0", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PAN_NUMBER", "doc_value": "BIAPA2934N", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PASSPORT_NUMBER", "doc_value": "L6892603", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "UIDAI_NUMBER", "doc_value": 753624181019, "status": "IN_REVIEW", "remarks": null } ] } } } } } }, "createVendorSuccessResponse": { "description": "Create Vendor Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVendorResponse" }, "examples": { "PG - Bank Account": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "bank": { "account_number": 26291800001191, "account_holder": "JOHN DOE", "ifsc": "YESB0000262" }, "upi": null, "phone": 9876543210, "name": "customer", "vendor_id": "TestAccount11", "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": false }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "pan": "AFDHK1234F", "uidai": null, "passport_number": null, "driving_license": null, "voter_id": null, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000" }, "dashboard_access": false, "bank_details": null } }, "PG - UPI": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "bank": null, "upi": { "vpa": "john@ybl", "account_holder": "JOHN DOE" }, "phone": 9876543210, "name": "customer", "vendor_id": "TestA2ccount211", "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": false }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "pan": "AFDHK1234F", "uidai": null, "passport_number": null, "driving_license": null, "voter_id": null, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000" }, "dashboard_access": false, "bank_details": null } }, "PG - Auto Collect": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "bank": null, "upi": { "vpa": "success@upi", "account_holder": "JOHN DOE" }, "phone": 9876543210, "name": "customer", "vendor_id": "vendortest123", "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": false }, "kyc_details": { "account_type": "INDIVIDUAL", "business_type": "NBFC", "pan": "AFDHK1234F", "uidai": 456712345678, "passport_number": null, "driving_license": null, "voter_id": null, "gst": null, "cin": null }, "dashboard_access": false, "bank_details": null } } } } } }, "UpdateVendorSuccessResponse": { "description": "Update Vendor Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVendorResponse" }, "examples": { "PG - Bank Account": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "bank": { "account_number": 26291800001191, "account_holder": "JOHN DOE", "ifsc": "YESB0000262" }, "upi": null, "phone": 9876543210, "name": "customer", "vendor_id": "TestAccount11", "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": false }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "pan": "AFDHK1234F", "uidai": null, "passport_number": null, "driving_license": null, "voter_id": null, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000" }, "dashboard_access": false, "bank_details": null } }, "PG - UPI": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "bank": null, "upi": { "vpa": "john@ybl", "account_holder": "JOHN DOE" }, "phone": 9876543210, "name": "customer", "vendor_id": "TestA2ccount211", "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": false }, "kyc_details": { "account_type": "BUSINESS", "business_type": "NBFC", "pan": "AFDHK1234F", "uidai": null, "passport_number": null, "driving_license": null, "voter_id": null, "gst": "11AAAAA1111A1Z0", "cin": "L00000Aa0000AaA000000" }, "dashboard_access": false, "bank_details": null } }, "PG - Auto Collect": { "value": { "email": "johndoe@cashfree.com", "status": "IN_BENE_CREATION", "phone": 9876543210, "name": "customer", "vendor_id": "johntest11111", "added_on": "2023-03-02 12:12:56", "updated_on": "2023-03-02 12:12:57", "bank": { "account_number": 123456111110, "account_holder": "JOHNDOE", "ifsc": "YESB0000262" }, "upi": null, "schedule_option": { "settlement_schedule_message": "T+1 settlement at 11:00 AM", "schedule_id": 1, "merchant_default": true }, "vendor_type": "PG", "account_type": "BUSINESS", "business_type": "NBFC", "related_docs": [ { "vendor_id": "johntest11111", "doc_type": "CIN_NUMBER", "doc_value": "L00000Aa0000AaA000000", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "GSTIN_NUMBER", "doc_value": "11AAAAA1111A1Z0", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PAN_NUMBER", "doc_value": "BIAPA2934N", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "PASSPORT_NUMBER", "doc_value": "L6892603", "status": "IN_REVIEW", "remarks": null }, { "vendor_id": "johntest11111", "doc_type": "UIDAI_NUMBER", "doc_value": 753624181019, "status": "IN_REVIEW", "remarks": null } ] } } } } } }, "VendorAdjustmentSuccessResponse": { "description": "Vendor Adjustment Success Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorAdjustmentSuccessResponse" }, "examples": { "PG": { "value": { "message": "Vendor & merchant balances updated", "status": "OK" } } } } } }, "SplitOrderReconSuccessResponse": { "description": "Get Split and Settlement Details by OrderID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitOrderReconSuccessResponse" }, "examples": { "PG": { "value": { "settlement": { "entity": "settlement", "cf_settlement_id": 4301319325, "cf_payment_id": 5114912996630, "order_id": "order_1527072nQIWwJ96IRVKmGnysmYtqekXLv", "order_currency": "INR", "transfer_id": null, "order_amount": 3000, "service_charge": 57, "service_tax": 10.26, "settlement_amount": 2100, "settlement_currency": "INR", "transfer_utr": null, "transfer_time": null, "payment_time": "2024-10-14T15:12:08+05:30" }, "refunds": [], "vendors": [ { "vendor_id": "test02", "settlement_id": 87168, "settlement_amount": 600, "settlement_eligibility_date": "2024-10-14 15:27:08" }, { "vendor_id": "test03", "settlement_id": 87167, "settlement_amount": 300, "settlement_eligibility_date": "2024-10-14 15:27:08" } ] } } } } } }, "Response404SplitOrderRecon": { "description": "Split Order Recon Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Order not present": { "value": { "message": "Order Reference Id does not exist", "code": "order_not_found", "type": "invalid_request_error" } } } } } }, "Response400VendorAdjustment": { "description": "Adjust Vendor Balance Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Vendor does not exist": { "value": { "message": "vendor does not exist", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid transfer amount": { "value": { "message": "Amount should be greater than zero", "code": "api_request_failed", "type": "invalid_request_error" } }, "No sufficient balance with vendor": { "value": { "message": "Vendor does not have sufficient balance", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400InvalidVendorId": { "description": "Get Vendor Docs Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Invalid vendorID": { "value": { "message": "vendor does not exist", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400CreateSettlementorder": { "description": "Create Settlement Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Duplicate Request": { "value": { "message": "Duplicate request", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid date or null date": { "value": { "message": "Invalid settlementDate Format", "code": "api_request_failed", "type": "INVALID_REQUEST_TYPE" } } } } } }, "Response404CreateSettlementorder": { "description": "Create Settlement Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Duplicate Request": { "value": { "message": "Order Reference Id does not exist", "code": "order_not_found", "type": "invalid_request_error" } } } } } }, "Response400GetVendorBalanceTransferCharges": { "description": "Get Vendor Balance Transfer Charges Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Invalid rate type": { "value": { "message": "The parameter rateType must have a value among : VENDOR_ON_DEMAND,", "code": "api_request_failed", "type": "invalid_request_error" } }, "Rate not found": { "value": { "message": "Rate not found", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response404SplitAfterPayment": { "description": "Split After Payment Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError404" }, "examples": { "404": { "value": { "message": "Order not found", "code": "order_not_found,", "type": "invalid_request_error" } } } } } }, "Response409SplitAfterPayment": { "description": "Split After Payment Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError409" }, "examples": { "409": { "value": { "message": "Transaction already processed, not eligible for split", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400StaticSplit": { "description": "Static Split Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Vendor does not exist": { "value": { "message": "vendor does not exist", "code": "api_request_failed", "type": "invalid_request_error" } }, "Easy Split not enabled": { "value": { "message": "Merchant not enabled with easy splits", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid product type": { "value": { "message": "product_type : should be STATIC_QR SBC PG EPOS. Value received: P2G", "code": "product_type_invalid", "type": "invalid_request_error" } }, "Split percentage less than min": { "value": { "message": "split percentage cannot be <=0 for a vendor", "code": "INVALID_REQUEST_TYPE", "type": "invalid_request_error" } }, "Split percentage greater than max": { "value": { "message": "total split percentage cannot be > 100", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400ESOrderRecon": { "description": "ES Order Recon Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Filter not present": { "value": { "message": "At least one of the filters needs to be present orderIds or Date", "code": "request_failed", "type": "invalid_request_error" } } } } } }, "Response404ESOrderRecon": { "description": "ES Order Recon Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Order not found": { "value": { "message": "Order not found", "code": "order_not_found", "type": "invalid_request_error" } } } } } }, "Response409ESOrderRecon": { "description": "ES Order Recon Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Settlement already initiated to merchant": { "value": { "message": "Transaction already processed, not eligible for split", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400SplitAfterPayment": { "description": "Split After Payment Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Invalid vendor ID": { "value": { "message": "vendor does not exist", "code": "api_request_failed", "type": "invalid_request_error" } }, "Split amount greater than order amount": { "value": { "message": "Total split amount can not be greater than transaction amount / eligible split balance", "code": "api_request_failed", "type": "invalid_request_error" } }, "Both amount and percentage mentioned": { "value": { "message": "Invalid Request: Both Amount and percentage are present", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid percentage": { "value": { "message": "Invalid vendor split percentage", "code": "api_request_failed", "type": "invalid_request_error" } }, "Split already exist": { "value": { "message": "Transaction already processed, not eligible for split", "code": "api_request_failed", "type": "invalid_request_error" } }, "Transaction not synced yet": { "value": { "message": "Transaction is not synced, please retry after 2 mins", "code": "api_request_failed", "type": "invalid_request_error" } }, "Order not paid": { "value": { "message": "Order not paid", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400AdjustVendorBalance": { "description": "Adjust Vendor Balance Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Vendor does not exist": { "value": { "message": "vendor does not exist", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid transfer amount": { "value": { "message": "Transfer amount should be greater than or equal to 10", "code": "api_request_failed", "type": "invalid_request_error" } }, "No sufficient balance with vendor": { "value": { "message": "VENDOR does not have sufficient funds for express settlement", "code": "api_request_failed", "type": "invalid_request_error" } }, "No sufficient balance with merchant": { "value": { "message": "MERCHANT does not have sufficient funds for express settlement", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400CreateVendor": { "description": "Create Vendor Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Invalid vendorID": { "value": { "message": "vendor_id: should be alpha numeric. Value received: testvend@or", "code": "vendor_id_invalid", "type": "invalid_request_error" } }, "Invalid vendor status": { "value": { "message": "status: should be ACTIVE BLOCKED. Value received: NEW", "code": "status_invalid", "type": "invalid_request_error" } }, "Invalid customer name size": { "value": { "message": "[size must be between 0 and 100 but it was nG3apOaiBGT0AS4C0Qmq7QdW25IEHv8Y1hACb60dBdkdMbRBgaBS3bePo0yRTLAZB0yoYlZfjktsHSGWsGlCSeq18Z5SeOIY7mliE]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Customer name missing": { "value": { "message": "name: is missing in the request. Value received: \"\"", "code": "name_missing", "type": "invalid_request_error" } }, "Invalid customer name": { "value": { "message": "[Invalid Name. Name should not have any special character except . / - & but it was @Devraj]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid email ID": { "value": { "message": "email: should be valid email. Value received: arun@@cashfree.com", "code": "email_invalid", "type": "invalid_request_error" } }, "Email ID missing": { "value": { "message": "email: is missing in the request. Value received: \"\"", "code": "email_missing", "type": "invalid_request_error" } }, "Invalid phone number": { "value": { "message": "[Enter valid phone number. but it was 8867456990734887837434]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid verify status": { "value": { "message": "invalid character '2' in literal true (expecting 'u')", "code": "request_failed", "type": "invalid_request_error" } }, "Invalid dashboard access status": { "value": { "message": "invalid character '2' in literal true (expecting 'u')", "code": "request_failed", "type": "invalid_request_error" } }, "Invalid VPA": { "value": { "message": "upi.vpa: invalid VPA provided. Value received: 026291800001191", "code": "upi.vpa_invalid", "type": "invalid_request_error" } }, "Invalid account holder name": { "value": { "message": "[Invalid account holder name. Account holder name should not have any special character except . / - & but it was John_Doe]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid UIDAI number": { "value": { "message": "[Please enter valid UIDAI number but it was 456712345678]]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid GST number": { "value": { "message": "[Please enter valid GST number but it was 11AAAAA1111A1@Z0]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid CIN number": { "value": { "message": "[Please enter valid CIN number but it was L00000Aa0000AaA@000000]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid PAN number": { "value": { "message": "kyc_details.pan: is missing in the request. Value received: \"\"", "code": "kyc_details.pan_missing", "type": "invalid_request_error" } }, "Invalid Passport number": { "value": { "message": "[Please enter valid PASSPORT number but it was L68926@03]]", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "Response400UploadVendorDocs": { "description": "Upload Vendor Docs Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Invalid vendorID": { "value": { "message": "vendor_id: should be alpha numeric. Value received: testvend@or", "code": "vendor_id_invalid", "type": "invalid_request_error" } }, "Doc Type Missing": { "value": { "message": "doc_type : is missing in the request. Value received: \"\"", "code": "doc_type_missing", "type": "invalid_request_error" } } } } } }, "Response400UpdateVendor": { "description": "Update Vendor Failure Response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError" }, "examples": { "Invalid vendorID": { "value": { "message": "vendor_id: should be alpha numeric. Value received: testvend@or", "code": "vendor_id_invalid", "type": "invalid_request_error" } }, "Invalid vendor status": { "value": { "message": "status: should be ACTIVE BLOCKED. Value received: NEW", "code": "status_invalid", "type": "invalid_request_error" } }, "Invalid customer name size": { "value": { "message": "[size must be between 0 and 100 but it was nG3apOaiBGT0AS4C0Qmq7QdW25IEHv8Y1hACb60dBdkdMbRBgaBS3bePo0yRTLAZB0yoYlZfjktsHSGWsGlCSeq18Z5SeOIY7mliE]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid customer name": { "value": { "message": "[Invalid Name. Name should not have any special character except . / - & but it was @Devraj]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid email ID": { "value": { "message": "email: should be valid email. Value received: arun@@cashfree.com", "code": "email_invalid", "type": "invalid_request_error" } }, "Invalid phone number": { "value": { "message": "[Enter valid phone number. but it was 8867456990734887837434]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid VPA": { "value": { "message": "upi.vpa: invalid VPA provided. Value received: 026291800001191", "code": "upi.vpa_invalid", "type": "invalid_request_error" } }, "Invalid account holder name": { "value": { "message": "[Invalid account holder name. Account holder name should not have any special character except . / - & but it was John_Doe]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid UIDAI number": { "value": { "message": "[Please enter valid UIDAI number but it was 456712345678]]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid GST number": { "value": { "message": "[Please enter valid GST number but it was 11AAAAA1111A1@Z0]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid CIN number": { "value": { "message": "[Please enter valid CIN number but it was L00000Aa0000AaA@000000]", "code": "api_request_failed", "type": "invalid_request_error" } }, "Invalid PAN number": { "value": { "message": "kyc_details.pan: is missing in the request. Value received: \"\"", "code": "kyc_details.pan_missing", "type": "invalid_request_error" } }, "Invalid Passport number": { "value": { "message": "[Please enter valid PASSPORT number but it was L68926@03]]", "code": "api_request_failed", "type": "invalid_request_error" } } } } } }, "UploadPnachImage200Response": { "description": "Upload Pnach Image 200 response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPnachImageResponse" }, "examples": { "successful_upload": { "value": { "payment_id": "payment-1234", "authorization_status": "INITIALIZED", "action": "SUBMIT_DOCUMENT", "payment_message": "file uploaded successfully." } } } } } }, "SubscriptionEligibility200Response": { "description": "Subscrition eligibility API 200 response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionEligibilityResponse" }, "examples": { "all payment methods response": { "value": [ { "eligibility": true, "entity_type": "payment_methods", "entity_value": "enach", "entity_details": { "account_types": [ "SAVINGS", "CURRENT" ], "frequent_bank_details": [ { "bank_id": "SBIN", "bank_name": "STATE BANK OF INDIA", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING" ] }, { "bank_id": "BARB", "bank_name": "BANK OF BARODA", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING" ] }, { "bank_id": "ICIC", "bank_name": "ICICI BANK LTD", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING", "AADHAAR" ] }, { "bank_id": "HDFC", "bank_name": "HDFC BANK LTD", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING", "AADHAAR" ] } ], "all_bank_details": [ { "bank_id": "SBIN", "bank_name": "STATE BANK OF INDIA", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING" ] }, { "bank_id": "BARB", "bank_name": "BANK OF BARODA", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING" ] }, { "bank_id": "ICIC", "bank_name": "ICICI BANK LTD", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING", "AADHAAR" ] }, { "bank_id": "HDFC", "bank_name": "HDFC BANK LTD", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING", "AADHAAR" ] }, { "bank_id": "UTKS", "bank_name": "UTKARSH SMALL FINANCE BANK LTD", "account_auth_modes": [ "DEBIT_CARD" ] }, { "bank_id": "YESB", "bank_name": "YES BANK", "account_auth_modes": [ "DEBIT_CARD", "NET_BANKING", "AADHAAR" ] } ] } }, { "eligibility": true, "entity_type": "payment_methods", "entity_value": "upi", "entity_details": { "available_handles": [ { "handle": "okaxis", "application": "Google Pay" }, { "handle": "ybl", "application": "PhonePe" } ] } }, { "eligibility": true, "entity_type": "payment_methods", "entity_value": "card", "entity_details": { "allowed_card_types": [ "CREDIT_CARD", "DEBIT_CARD" ] } }, { "eligibility": true, "entity_type": "payment_methods", "entity_value": "pnach", "entity_details": { "account_types": [ "SAVINGS", "CURRENT" ], "all_bank_details": [ { "bank_id": "SRIX", "bank_name": "SRI SATYA SAI NAGRIK SAHAKARI BANK MYDT, BHOPAL" }, { "bank_id": "ISUX", "bank_name": "THE ISLAMPUR URBAN CO OPERATIVE BANK LIMITED" }, { "bank_id": "ZCBL", "bank_name": "THE ZOROASTRIAN CO OP BANK LTD" } ] } } ] } } } } } }, "examples": { "VendorReconACResponseExample": { "value": { "cursor": null, "data": [ { "amount": 200, "settlement_eligibility_time": "2022-09-07 08:00:00", "merchant_order_id": "order_1527072EOGQLB2sEuL206y2hcXzB0ITu6", "tx_time": "2022-09-06 15:43:20", "settlement_id": 10253, "settled": true, "fee": "NA", "tax": "NA", "entity_id": "885568174", "type": "transaction", "merchant_vendor_id": "test01", "added_on_time": "2022-09-06 15:43:28", "settlement_time": "2022-09-06 16:15:03", "settlement_utr": "1662461103581582", "currency": "INR", "debit": "NA", "credit": "200.0", "refund_arn": "order_1527072EOGQLB2sEuL206y2hcXzB0ITu6" }, { "settlement_eligibility_time": "NA", "merchant_order_id": "NA", "tx_time": "2022-09-06 16:15:01", "settlement_id": 10253, "settled": true, "fee": "0.0", "tax": "0.0", "entity_id": "10253", "type": "vendor_settlement", "merchant_vendor_id": "test01", "added_on_time": "2022-09-06 16:15:01", "settlement_time": "2022-09-06 16:15:03", "settlement_utr": "1662461103581582", "currency": "INR", "debit": "400.0", "credit": "NA", "refund_arn": "NA" }, { "amount": 100, "settlement_eligibility_time": "NA", "merchant_order_id": "order_1527072EOGQLB2sEuL206y2hcXzB0ITu6", "tx_time": "2022-09-06 16:32:49", "fee": "NA", "tax": "NA", "entity_id": "REF_ee880c02-6438-4f4f-ba0a-b422da63e195", "type": "REFUND", "merchant_vendor_id": "test01", "added_on_time": "2022-09-06 16:32:49", "settlement_time": "NA", "settlement_utr": "NA", "currency": "INR", "debit": "100.0", "credit": "NA", "refund_arn": "order_1527072EOGQLB2sEuL206y2hcXzB0ITu6" } ], "limit": 3 } }, "VendorReconPGResponseExample": { "value": { "cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTI4ODVdLCJlbXB0eSI6ZmFsc2V9LCJyZXBvcnRUeXBlIjoidmVuZG9yX2FkanVzdG1lbnRfcmVjb24ifQ==", "data": [ { "amount": 70, "settlement_eligibility_time": "2023-08-18 13:47:09", "merchant_order_id": "order_1527072U9JADzyG7V93d9xG7goO6xo8C6", "tx_time": "2023-08-18 13:32:09", "settlement_id": 51709, "settled": true, "fee": "NA", "tax": "NA", "entity_id": "2148545831", "type": "transaction", "merchant_vendor_id": "test03", "added_on_time": "2023-08-18 13:32:21", "settlement_time": "2023-08-22 10:34:11", "settlement_utr": "1692680651484925", "currency": "INR", "debit": "NA", "credit": "70.0", "refund_arn": "order_1527072U9JADzyG7V93d9xG7goO6xo8C6" }, { "amount": 2500, "settlement_eligibility_time": "2023-08-18 18:25:04", "merchant_order_id": "order_1527072U9qz76SXfmFPbu1Z1BfTa4lNW5", "tx_time": "2023-08-18 18:10:04", "settlement_id": 51709, "settled": true, "fee": "NA", "tax": "NA", "entity_id": "2148548184", "type": "transaction", "merchant_vendor_id": "test03", "added_on_time": "2023-08-18 18:10:06", "settlement_time": "2023-08-22 10:34:11", "settlement_utr": "1692680651484925", "currency": "INR", "debit": "NA", "credit": "2500.0", "refund_arn": "order_1527072U9qz76SXfmFPbu1Z1BfTa4lNW5" }, { "amount": 2500, "settlement_eligibility_time": "2023-08-18 18:33:00", "merchant_order_id": "order_1527072U9rwyUDlUqtkYpRyGtu3A6tfgy", "tx_time": "2023-08-18 18:18:00", "settlement_id": 51709, "settled": true, "fee": "NA", "tax": "NA", "entity_id": "2148548225", "type": "transaction", "merchant_vendor_id": "test03", "added_on_time": "2023-08-18 18:18:02", "settlement_time": "2023-08-22 10:34:11", "settlement_utr": "1692680651484925", "currency": "INR", "debit": "NA", "credit": "2500.0", "refund_arn": "order_1527072U9rwyUDlUqtkYpRyGtu3A6tfgy" }, { "settlement_eligibility_time": "NA", "merchant_order_id": "NA", "tx_time": "2023-08-18 17:54:55", "settlement_id": 51678, "fee": "10.0", "tax": "1.8", "entity_id": "51678", "type": "vendor_settlement", "merchant_vendor_id": "test03", "added_on_time": "2023-08-18 17:54:55", "currency": "INR", "debit": "0.0", "credit": "NA", "refund_arn": "NA" }, { "settlement_eligibility_time": "NA", "merchant_order_id": "NA", "tx_time": "2023-08-18 17:58:49", "settlement_id": 51680, "settled": true, "fee": "10.0", "tax": "1.8", "entity_id": "51680", "type": "vendor_settlement", "merchant_vendor_id": "test03", "added_on_time": "2023-08-18 17:58:49", "settlement_time": "2023-08-18 17:58:51", "settlement_utr": "1692361731372244", "currency": "INR", "debit": "0.0", "credit": "NA", "refund_arn": "NA" } ], "limit": 15 } }, "card_offer": { "summary": "Create a Card Offer", "description": "card offer example", "value": { "offer_meta": { "offer_title": "Test Offer", "offer_description": "Offer Description", "offer_code": "CFTESTOFFER", "offer_start_time": "2023-03-21T08:09:51Z", "offer_end_time": "2024-03-21T08:09:51Z" }, "offer_tnc": { "offer_tnc_type": "text", "offer_tnc_value": "Terms and Condition of the Offer" }, "offer_details": { "offer_type": "DISCOUNT_AND_CASHBACK", "discount_details": { "discount_type": "flat", "discount_value": "10", "max_discount_amount": "10" }, "cashback_details": { "cashback_type": "percentage", "cashback_value": "10", "max_cashback_amount": "10" } }, "offer_validations": { "min_amount": 15, "max_allowed": 100, "payment_method": { "card": { "type": [ "cc" ], "bank_name": "hdfc bank", "scheme_name": [ "visa" ] } } } } }, "create_customer": { "description": "Example request to create a customer", "value": { "customer_phone": "9999999999", "customer_email": "prasun@example.com", "customer_name": "Prasun" } }, "customer_entity_example": { "description": "CustomerEntityExample", "summary": "CustomerEntityExample", "value": [ { "customer_uid": "cfcustom_78364873648723", "customer_phone": "9999999999", "customer_email": "prasun@example.com", "customer_name": "Prasun" } ] }, "eligibility_cardless_emi": { "summary": "Get Eligible Cardless EMI", "description": "Check cardless emi eligibilty", "value": { "queries": { "amount": 10000, "customer_details": { "customer_phone": "9898989898" } } } }, "eligible_all_payment_methods": { "description": "Check eligibilty of Payment Methods", "summary": "Eligible Payment Methods - All", "value": { "queries": { "amount": 100 } } }, "eligible_card_payment_methods": { "description": "Check eligibilty of Payment Methods", "summary": "Eligible Payment Methods - Card", "value": { "filters": { "payment_methods": [ "debit_card", "credit_card", "prepaid_card", "corporate_credit_card" ] }, "queries": { "amount": 100 } } }, "eligible_netbanking_payment_methods": { "description": "Check eligibilty of Payment Methods", "summary": "Eligible Payment Methods - Netbanking", "value": { "filters": { "payment_methods": [ "netbanking" ] }, "queries": { "amount": 100 } } }, "eligible_no_cost_emi_offers": { "summary": "Eligible No-Cost EMI Offers", "description": "Check nocost emi eligibilty", "value": { "queries": { "amount": 1000 }, "filters": { "offer_type": [ "NO_COST_EMI" ] } } }, "eligible_offers": { "summary": "Eligible Offers", "description": "Check offers eligibilty", "value": { "queries": { "amount": 1000 } } }, "eligible_paylater": { "summary": "Eligible Paylater", "description": "Check Paylater eligibilty", "value": { "queries": { "amount": 10000, "customer_details": { "customer_phone": "9898989898" } } } }, "fetch_all_saved_cards_example": { "summary": "Saved Intruments", "description": "all saved intrument example", "value": [ { "customer_id": "siddhesh_desai", "afa_reference": "740324562", "instrument_id": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10", "instrument_type": "card", "instrument_uid": "0d8f70838cc5af8b1cd2bc0fe71278551fd3f1101e40020d89ad22ceba4f933c", "instrument_display": "xxxxxxxxxxxx4375", "instrument_status": "ACTIVE", "created_at": "2021-11-11 16:57:57", "instrument_meta": { "card_network": "VISA", "card_bank_name": "HDFC Bank Limited", "card_country": "IN", "card_type": "DEBIT_CARD", "card_token_details": { "par": "somepar", "expiry_month": "12", "expiry_year": "23" } } } ] }, "issuer_guest_checkout_token_number": { "description": "Pay using Issuer Guest Checkout Token", "summary": "Pay using Issuer Guest Checkout Token", "value": { "payment_method": { "card": { "card_cvv": "900", "card_display": "3243", "card_expiry_mm": "03", "card_expiry_yy": "26", "card_number": "4111111111111111", "channel": "link", "cryptogram": "AQBBBBBBZatIlaIAmWKSghwBBBB=", "token_requestor_id": "22457512314", "token_type": "ISSUER_GC_TOKEN" } }, "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn" } }, "issuer_token_number": { "description": "Pay using Issuer Token Number", "summary": "Pay using Issuer Token Number", "value": { "payment_method": { "card": { "card_cvv": "900", "card_display": "3243", "card_expiry_mm": "03", "card_expiry_yy": "26", "card_number": "4111111111111111", "channel": "link", "cryptogram": "AQBBBBBBZatIlaIAmWKSghwBBBB=", "token_requestor_id": "22457512314", "token_type": "ISSUER_TOKEN" } }, "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn" } }, "net_banking_offer": { "summary": "Create a Net Banking Offer", "description": "Offer Netbanking", "value": { "offer_meta": { "offer_title": "Test Offer", "offer_description": "Offer Description", "offer_code": "CFTESTOFFER", "offer_start_time": "2023-03-21T08:09:51Z", "offer_end_time": "2024-03-21T08:09:51Z" }, "offer_tnc": { "offer_tnc_type": "text", "offer_tnc_value": "Terms and Condition of the Offer" }, "offer_details": { "offer_type": "DISCOUNT_AND_CASHBACK", "discount_details": { "discount_type": "flat", "discount_value": "10", "max_discount_amount": "10" }, "cashback_details": { "cashback_type": "percentage", "cashback_value": "10", "max_cashback_amount": "10" } }, "offer_validations": { "min_amount": 12, "max_allowed": 100, "payment_method": { "netbanking": { "bank_name": "all" } } } } }, "network_guest_checkout_token_number": { "description": "Pay using Network Guest Checkout Token", "summary": "Pay using Network Guest Checkout Token", "value": { "payment_method": { "card": { "card_cvv": "900", "card_display": "3243", "card_expiry_mm": "03", "card_expiry_yy": "26", "card_number": "4111111111111111", "channel": "link", "cryptogram": "AQBBBBBBZatIlaIAmWKSghwBBBB=", "token_requestor_id": "22457512314", "token_type": "NETWORK_GC_TOKEN" } }, "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn" } }, "no_cost_emi_offer": { "summary": "Create a No Cost EMI Offer", "description": "No cost EMI", "value": { "offer_meta": { "offer_title": "Test Offer", "offer_description": "Offer Description", "offer_code": "CFTESTOFFER", "offer_start_time": "2023-03-21T08:09:51Z", "offer_end_time": "2024-03-21T08:09:51Z" }, "offer_tnc": { "offer_tnc_type": "text", "offer_tnc_value": "Terms and Condition of the Offer" }, "offer_details": { "offer_type": "NO_COST_EMI" }, "offer_validations": { "max_allowed": 10000, "payment_method": { "emi": { "type": "cardless_emi", "issuer": "hdfc bank", "tenures": [ 3, 6 ] } } } } }, "offer_entity_example": { "description": "offer entity example", "summary": "OfferEntityExample", "value": [ { "offer_id": "d2b430fb-1afe-455a-af31-66d00377b29a", "offer_status": "active", "offer_meta": { "offer_title": "some title", "offer_description": "some offer description", "offer_code": "CFTESTOFFER", "offer_start_time": "2023-03-21T08:09:51Z", "offer_end_time": "2023-03-29T08:09:51Z" }, "offer_tnc": { "offer_tnc_type": "text", "offer_tnc_value": "TnC for the Offer." }, "offer_details": { "offer_type": "DISCOUNT_AND_CASHBACK", "discount_details": { "discount_type": "flat", "discount_value": "10", "max_discount_amount": "10" }, "cashback_details": { "cashback_type": "percentage", "cashback_value": "20", "max_cashback_amount": "150" } }, "offer_validations": { "min_amount": 10, "payment_method": { "wallet": { "issuer": "paytm" } }, "max_allowed": 2 } } ] }, "order_customer": { "summary": "Customer Details", "description": "Complete customer details", "value": { "order_id": "playstation_purchase_1", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9908734801", "customer_email": "john@example.com", "customer_name": "John Doe" } } }, "order_customer_tpv": { "summary": "Customer TPV", "description": "Customer with bank details if provided he or she can pay by only that bank account", "value": { "order_id": "playstation_purchase_1", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_name": "John Doe", "customer_phone": "9908734801", "customer_email": "john@example.com", "customer_bank_ifsc": "XDFC0000045", "customer_bank_account_number": "123124123123123", "customer_bank_code": 3021 } } }, "order_entity_list_example": { "description": "OrderEntityListExample", "summary": "OrderEntityListExample", "value": [ { "cf_order_id": "2149460581", "created_at": "2023-08-11T18:02:46+05:30", "customer_details": { "customer_id": "409128494", "customer_name": "Johmn Doe", "customer_email": "pmlpayme@ntsas.com", "customer_phone": "9876543210", "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10" }, "entity": "order", "order_amount": 22, "payment_session_id": "session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH", "order_currency": "INR", "order_expiry_time": "2023-09-09T18:02:46+05:30", "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij", "order_meta": { "return_url": "https://www.cashfree.com/devstudio/thankyou", "payment_methods": "cc", "notify_url": "https://example.com/cf_notify" }, "order_note": "some order note LIST", "order_splits": [], "order_status": "ACTIVE", "order_tags": { "name": "John", "age": "19" }, "terminal_data": null, "cart_details": { "cart_id": "1" } } ] }, "order_extended_data_entity_list_example": { "description": "OrderExtendedEntityDataExample", "summary": "OrderExtendedEntityDataExample", "value": [ { "cf_order_id": "2149460581", "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij", "order_amount": 22, "order_currency": "INR", "created_at": "2023-08-11T18:02:46+05:30", "charges": { "shipping_charges": 5, "cod_handling_charges": 10 }, "customer_details": { "customer_id": "409128494", "customer_name": "Aditya Keshri", "customer_email": "pmlpayme@ntsas.com", "customer_phone": "9876543210", "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10" }, "shipping_address": { "name": "Saurav Singh", "address_line_one": "MK Building", "address_line_two": "Test Address", "country": "India", "country_code": "IN", "state": "Karnataka", "state_code": "KA", "city": "Bangalore", "pin_code": "560034", "phone": "+91 1118911189", "email": "test@cashfree.com" }, "billing_address": { "name": "Saurav Singh", "address_line_one": "MK Building", "address_line_two": "Test Address", "country": "India", "country_code": "IN", "state": "Karnataka", "state_code": "KA", "city": "Bangalore", "pin_code": "560034", "phone": "+91 1118911189", "email": "test@cashfree.com" }, "cart": { "name": "test", "items": [ { "item_id": "26", "item_name": "Sample Product", "item_description": "item-description", "item_tags": [ "1", "2" ], "item_details_url": "http://cashfree.com", "item_image_url": "http://cashfree.com", "item_original_unit_price": "1", "item_discounted_unit_price": "1", "item_quantity": 1, "item_currency": "INR" }, { "item_id": "35", "item_name": "Sample Product", "item_description": "item-description", "item_tags": [ "1", "2" ], "item_details_url": "http://cashfree.com", "item_image_url": "http://cashfree.com", "item_original_unit_price": "1", "item_discounted_unit_price": "1", "item_quantity": 1, "item_currency": "INR" } ] }, "offer": { "offer_id": "d2b430fb-1afe-455a-af31-66d00377b29a", "offer_status": "active", "offer_meta": { "offer_title": "some title", "offer_description": "some offer description", "offer_code": "CFTESTOFFER", "offer_start_time": "2023-03-21T08:09:51Z", "offer_end_time": "2023-03-29T08:09:51Z" }, "offer_tnc": { "offer_tnc_type": "text", "offer_tnc_value": "TnC for the Offer." }, "offer_details": { "offer_type": "DISCOUNT_AND_CASHBACK", "discount_details": { "discount_type": "flat", "discount_value": "10", "max_discount_amount": "10" }, "cashback_details": { "cashback_type": "percentage", "cashback_value": "20", "max_cashback_amount": "150" } }, "offer_validations": { "min_amount": 10, "payment_method": { "wallet": { "issuer": "paytm" } }, "max_allowed": 2 } } } ] }, "update_order_extended_data_entity_list_example": { "description": "UpdateOrderExtendedEntityDataExample", "summary": "UpdateOrderExtendedEntityDataExample", "value": [ { "cf_order_id": "2149460581", "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij", "shipment_details": [ { "tracking_company": "DHL", "tracking_urls": [ "https://dhl.com/track/123456" ], "tracking_numbers": [ "TRACK123456" ] } ], "order_delivery_status": { "status": "CANCELLED", "reason": "wrong address" } } ] }, "order_expiry": { "summary": "With future expiry time for order", "description": "Add an exipry time for your order. No transactions would be accepted after the order has expired", "value": { "order_id": "playstation_purchase_5", "order_currency": "INR", "order_amount": 10.34, "order_expiry_time": "2021-07-29T00:00:00.000Z", "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" } } }, "order_invoice": { "summary": "With order invoice", "description": "Add invoice details for your order", "value": { "order_id": "playstation_purchase_6", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" }, "order_tags": { "gst": "1", "gstin": "27AAFCN5072P1ZV", "invoice_date": "2023-06-20T04:35:16.748Z", "invoice_number": "inv1687149916474", "invoice_link": "https://example.com/cf/nextgen.php#section-2", "invoice_name": "Walters Invoice", "cgst": "1", "sgst": "1", "igst": "1", "cess": "1", "gst_incentive": "1", "gst_percentage": "1", "pincode": "560034", "city_tier": "TIER1" } } }, "order_minimum": { "summary": "Minimun required details", "description": "Minimum set of parameters needed to create an order at cashfree", "value": { "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" } } }, "order_note": { "summary": "With additonal note", "description": "Add an additional note for your order which you can later use. It has to be string. For more detailed data use `order_tags`", "value": { "order_id": "playstation_purchase_6", "order_currency": "INR", "order_amount": 10.34, "order_note": "John buying playstation", "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" } } }, "order_orderid": { "summary": "Specify your order_id", "description": "You should always send `order_id`. If not sent Cashfree will generate one for you. This is useful during other api calls", "value": { "order_id": "playstation_purchase_1", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9908734801" } } }, "order_splits_amount": { "summary": "With order split Amount", "description": "Create an order where the amount received will be split between vendor and merchant based on absolute amount.", "value": { "order_id": "playstation_purchase_8", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" }, "order_splits": [ { "vendor_id": "Jane", "amount": 1.45, "tags": { "address": "Hyderabad" } }, { "vendor_id": "Barbie", "amount": 3.45, "tags": { "address": "Bengaluru, India" } } ] } }, "order_splits_cent": { "summary": "With order split Percentage", "description": "Create an order where the amount received will be split between vendors and merchant based on percentage.\nIn the below example order amount, let us say INR 200 will be divided like this\n- 33% to merchant becomes INR 66 \n- 20% to Jane becomes INR 40\n- 47% to Barbie becomes INR 94\n", "value": { "order_id": "playstation_purchase_8", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" }, "order_splits": [ { "vendor_id": "Jane", "percentage": 20 }, { "vendor_id": "Barbie", "percentage": 47 } ] } }, "order_tags": { "summary": "With order tags", "description": "Add key value pairs to your order. Can be used later in your workflow", "value": { "order_id": "playstation_purchase_6", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" }, "order_tags": { "address": "Bengaluru, India", "pincode": "560034" } } }, "order_with_payment_methods": { "summary": "With Payment Methods URL", "description": "add payment methods, customer can pnly pay using these payment methods only", "value": { "order_id": "playstation_purchase_4", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" }, "order_meta": { "return_url": "https://www.cashfree.com/devstudio/thankyou", "payment_methods": "cc,dc,upi" } } }, "order_with_return_url": { "summary": "With return/callback URL", "description": "add a return url to your order", "value": { "order_id": "playstation_purchase_2", "order_currency": "INR", "order_amount": 10.34, "customer_details": { "customer_id": "7112AAA812234", "customer_phone": "9898989898" }, "order_meta": { "return_url": "https://www.cashfree.com/devstudio/thankyou" } } }, "order_extended_minimum": { "summary": "Minimun required details", "description": "Minimum set of parameters needed to update shipment details", "value": { "shipment_details": [ { "tracking_company": "DHL", "tracking_urls": [ "https://dhl.com/track/123456" ], "tracking_numbers": [ "TRACK123456" ] } ] } }, "order_extended_delivery_status": { "summary": "Minimum required deatils for status", "description": "Minimum set of parameters needed to update shipment details", "value": { "order_delivery_status": { "status": "CANCELLED", "reason": "wrong address" } } }, "order_extended_all_field": { "summary": "With Shipment detail and delivery status", "description": "Request with all fields.", "value": { "shipment_details": [ { "tracking_company": "DHL", "tracking_urls": [ "https://dhl.com/track/123456" ], "tracking_numbers": [ "TRACK123456" ] } ], "order_delivery_status": { "status": "CANCELLED", "reason": "wrong address" } } }, "pay_card_headless": { "description": "Zero redirect Card Payment", "summary": "Card Headless OTP", "value": { "payment_session_id": "session_cChK4rQ9", "payment_method": { "card": { "channel": "post", "card_number": "4111111111111111", "card_expiry_mm": "03", "card_expiry_yy": "25", "card_cvv": "326" } } } }, "pay_ccemi": { "description": "Use Credit Card EMI 3 months", "summary": "CreditCard EMI", "value": { "payment_session_id": "session_ccemi", "payment_method": { "emi": { "channel": "link", "card_number": "4748461111111111", "card_expiry_mm": "12", "card_expiry_yy": "24", "card_cvv": "123", "card_bank_name": "ICICI", "emi_tenure": 3 } } } }, "pay_netbanking": { "description": "Pay by netbanking name", "summary": "NetBanking By Name", "value": { "payment_session_id": "session_someid", "payment_method": { "netbanking": { "channel": "link", "netbanking_bank_name": "TESTR" } } } }, "pay_netbanking_code": { "description": "Pay by netbanking Code", "summary": "NetBanking By Code", "value": { "payment_session_id": "session_someid", "payment_method": { "netbanking": { "channel": "link", "netbanking_bank_code": 3021 } } } }, "pay_upi_collect": { "description": "Customer will receive a notification on their phone to pay via UPI", "summary": "UPI Collect", "value": { "payment_session_id": "session_cChK4rQ9", "payment_method": { "upi": { "channel": "collect", "upi_id": "testsuccess@gocash" } } } }, "pay_upi_collect_redirect": { "description": "Redirect to loader page for UPI Collect", "summary": "UPI Collect Loader Page", "value": { "payment_session_id": "session_ehHbh0NXtVqlWwKS3acRxeT0uz5QuzHYgIBt8uLZ", "payment_method": { "upi": { "channel": "collect", "upi_id": "rajnandan1@oksomebank", "upi_redirect_url": true } } } }, "pay_upi_intent": { "description": "UPI intent. Opens UPI APP. Mobile only", "summary": "UPI Intent", "value": { "payment_session_id": "session__someidwhichislongandhasnumbers1232132andcharacterscn", "payment_method": { "upi": { "channel": "link" } } } }, "pay_upi_qr": { "description": "Get a `base64` QR Image", "summary": "QR Code", "value": { "payment_session_id": "session_somesessionid", "payment_method": { "upi": { "channel": "qrcode" } } } }, "pay_wallet_app": { "description": "Pay using PhonePe Wallet", "summary": "Wallet/APP", "value": { "payment_session_id": "session_ehHbh0NXtVqlWwKS3acRxeT0uz5t8uLZ", "payment_method": { "app": { "provider": "phonepe", "channel": "link", "phone": "8474090589" } } } }, "payments_entity_list_example": { "description": "Payments Entity List Example", "summary": "Payments Entity List Example", "value": [ { "cf_payment_id": "12376123", "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": null, "order_amount": 10.01, "order_currency": "INR", "is_captured": true, "payment_group": "upi", "authorization": { "action": "CAPTURE", "status": "PENDING", "captured_amount": 100, "start_time": "2022-02-09T18:04:34+05:30", "end_time": "2022-02-19T18:04:34+05:30", "approve_by": "2022-02-09T18:04:34+05:30", "action_reference": "6595231908096894505959", "action_time": "2022-08-03T16:09:51" }, "payment_method": { "upi": { "channel": "collect", "upi_id": "rohit@xcxcx", "upi_payer_ifsc": "AXL1234", "upi_payer_account_number": "XXXXXXX6024" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "SUCCESS", "payment_message": "Transaction successful", "bank_reference": "P78112898712", "auth_id": "A898101", "international_payment": { "international": false }, "payment_gateway_details": { "gateway_name": "CASHFREE", "gateway_order_id": "1234421ABD", "gateway_payment_id": "XABDJ2213", "gateway_order_reference_id": "BDIWO233", "gateway_settlement": "cashfree", "gateway_reference_name": "" } }, { "cf_payment_id": "12376124", "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": { "error_code": "TRANSACTION_DECLINED", "error_description": "issuer bank or payment service provider declined the transaction", "error_reason": "auth_declined", "error_source": "customer" }, "order_amount": 10.01, "order_currency": "INR", "is_captured": true, "payment_group": "credit_card", "authorization": null, "payment_method": { "card": { "channel": "link", "card_number": "xxxxxx1111" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "FAILED", "payment_message": "Transaction failed", "bank_reference": "P78112898712", "auth_id": "A898101", "international_payment": { "international": false }, "payment_gateway_details": { "gateway_name": "CASHFREE", "gateway_order_id": "1234421ABD", "gateway_payment_id": "XABDJ2213", "gateway_order_reference_id": "BDIWO233", "gateway_settlement": "cashfree", "gateway_reference_name": "" } }, { "cf_payment_id": "12376152", "order_id": "order_8125", "entity": "payment", "payment_currency": "USD", "error_details": { "error_code": "TRANSACTION_DECLINED", "error_description": "issuer bank or payment service provider declined the transaction", "error_reason": "auth_declined", "error_source": "customer" }, "order_amount": 100, "order_currency": "INR", "is_captured": true, "payment_group": "credit_card", "authorization": null, "payment_method": { "card": { "channel": "link", "card_number": "xxxxxx1111" } }, "payment_amount": 1.25, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "FAILED", "payment_message": "Transaction failed", "bank_reference": "P78112812312", "auth_id": "A851201", "international_payment": { "international": true }, "payment_gateway_details": { "gateway_name": "CASHFREE", "gateway_order_id": "3462421ABD", "gateway_payment_id": "XAUIH2213", "gateway_order_reference_id": "ZD5WO253", "gateway_settlement": "cashfree", "gateway_reference_name": "" } } ] }, "terminal_payments_entity_list_example": { "description": "Payments Entity List Example", "summary": "Payments Entity List Example", "value": [ { "cf_payment_id": "12376123", "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": null, "order_amount": 10.01, "is_captured": true, "payment_group": "upi", "authorization": { "action": "CAPTURE", "status": "PENDING", "captured_amount": 100, "start_time": "2022-02-09T18:04:34+05:30", "end_time": "2022-02-19T18:04:34+05:30", "approve_by": "2022-02-09T18:04:34+05:30", "action_reference": "6595231908096894505959", "action_time": "2022-08-03T16:09:51" }, "payment_method": { "upi": { "channel": "collect", "upi_id": "rohit@xcxcx", "upi_payer_ifsc": "AXL1234", "upi_payer_account_number": "XXXXXXX6024" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "SUCCESS", "payment_message": "Transaction successful", "bank_reference": "P78112898712", "auth_id": "A898101", "customer_details": { "customer_id": "7112AAA812234", "customer_email": "john@cashfree.com", "customer_phone": "9908734801", "customer_name": "John Doe" }, "payment_gateway_details": { "gateway_name": "CASHFREE", "gateway_order_id": "1234421ABD", "gateway_payment_id": "XABDJ2213", "gateway_order_reference_id": "BDIWO233", "gateway_settlement": "cashfree", "gateway_reference_name": "" } }, { "cf_payment_id": "12376124", "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": { "error_code": "TRANSACTION_DECLINED", "error_description": "issuer bank or payment service provider declined the transaction", "error_reason": "auth_declined", "error_source": "customer" }, "order_amount": 10.01, "is_captured": true, "payment_group": "credit_card", "authorization": null, "payment_method": { "card": { "channel": "link", "card_number": "xxxxxx1111" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "FAILED", "payment_message": "Transaction failed", "bank_reference": "P78112898712", "auth_id": "A898101", "customer_details": { "customer_id": "7112AAA812234", "customer_email": "john@cashfree.com", "customer_phone": "9908734801", "customer_name": "John Doe" }, "payment_gateway_details": { "gateway_name": "CASHFREE", "gateway_order_id": "1234421ABD", "gateway_payment_id": "XABDJ2213", "gateway_order_reference_id": "BDIWO233", "gateway_settlement": "cashfree", "gateway_reference_name": "" } } ] }, "plain_card": { "summary": "Pay using plain card", "description": "Plain card payment method", "value": { "payment_session_id": "session__someidwhichislongandhasnumbers1232132andcharacterscn", "payment_method": { "card": { "channel": "link", "card_number": "4111111111111111", "card_holder_name": "Tushar Gupta", "card_expiry_mm": "06", "card_expiry_yy": "22", "card_cvv": "900" } } } }, "refunds_entity_example": { "summary": "Refund Entity", "description": "complete refund object", "value": [ { "cf_payment_id": "918812", "cf_refund_id": "1553338", "refund_id": "REF-123", "order_id": "c6G-QMcbm1848", "entity": "refund", "refund_amount": 100.81, "refund_currency": "INR", "refund_note": "Refund for order #123", "refund_status": "SUCCESS", "refund_type": "MERCHANT_INITIATED", "refund_splits": [], "status_description": "In Progress", "refund_arn": "RF12312", "metadata": null, "created_at": "2021-07-25T08:57:52+05:30", "processed_at": "2021-07-25T12:57:52+05:30", "refund_charge": 0, "refund_mode": "STANDARD", "forex_conversion_handling_charge": 11.12, "forex_conversion_handling_tax": 1.12, "forex_conversion_rate": 84.24, "charges_currency": "INR" } ] }, "save_card_during_payment": { "summary": "Plain card + save card", "description": "Save a plain card for future payments", "value": { "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn", "payment_method": { "card": { "channel": "link", "card_number": "4111111111111111", "card_holder_name": "Tushar Gupta", "card_expiry_mm": "06", "card_expiry_yy": "22", "card_cvv": "900" } }, "save_instrument": true } }, "saved_card": { "summary": "Instrument id of saved card", "description": "pay using instrument id or saved card", "value": { "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn", "payment_method": { "card": { "channel": "link", "instrument_id": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10", "card_cvv": "900" } } } }, "token_card": { "summary": "Card network token and cryptogram", "description": "Pay using card network token and cryptogram", "value": { "payment_session_id": "session__CvcEmNKDkmERQrxnx39ibhJ3Ii034pjc8ZVxf3qcgEXCWlgDDlHRgz2XYZCqpajDQSXMMtCusPgOIxYP2LZx0-05p39gC2Vgmq1RAj--gcn", "payment_method": { "card": { "channel": "link", "card_number": "4111111111111111", "card_expiry_mm": "03", "card_expiry_yy": "26", "cryptogram": "AQBBBBBBZatIlaIAmWKSghwBBBB=", "card_cvv": "900", "token_requestor_id": "22457512314", "card_display": "3243" } } } }, "create_subscription_charge": { "description": "Create Payment. Charge Subscription", "summary": "Create Payment", "value": { "subscription_id": "test-subscription-id", "payment_id": "test-payment-id", "payment_amount": 10, "payment_schedule_date": "2024-04-18T16:40:00", "payment_remarks": "2nd EMI payment", "payment_type": "CHARGE", "payment_method": { "upi": { "upi_id": "john@upi", "channel": "COLLECT" } } } }, "create_subscription_auth": { "description": "Create Auth.", "summary": "Create Auth", "value": { "subscription_id": "test-subscription-id", "subscription_session_id": "sub_session_Vf5ZOcJTbGkcw4kcpayment", "payment_id": "test-payment-id", "payment_type": "AUTH", "payment_method": { "enach": { "channel": "link", "auth_mode": "net_banking", "account_holder_name": "John Doe", "account_number": "1518121112", "account_type": "SAVINGS", "account_bank_code": "ICIC" } } } } }, "headers": { "x-api-version": { "schema": { "type": "string", "format": "YYYY-MM-DD", "enum": [ "2022-09-01" ] }, "description": "This header has the version of the API. The current version is `2022-09-01`." }, "x-idempotency-key": { "schema": { "type": "string" }, "example": "some-idem-id", "description": "An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions." }, "x-idempotency-replayed": { "schema": { "type": "string", "format": "boolean" }, "example": "true", "description": "In conjunction with `x-idempotency-key` this means\n- `true` if the response was replayed\n- `false` if the response has not been replayed" }, "x-ratelimit-limit": { "schema": { "type": "integer" }, "example": 200, "description": "Ratelimit set for your account for this API per minute" }, "x-ratelimit-remaining": { "schema": { "type": "integer" }, "example": 2, "description": "Rate limit remaning for your account for this API in the next minute. Uses sliding window" }, "x-ratelimit-retry": { "schema": { "type": "integer" }, "example": 4, "description": "Contains number of seconds to wait if rate limit is breached\n- Is 0 if withing the limit\n- Is between 1 and 59 if breached\n" }, "x-ratelimit-type": { "schema": { "type": "string", "enum": [ "app_id", "ip" ] }, "example": "ip", "description": "either ip or app_id\n- `ip` if making a call from the browser. True for api where you don't need `x-client-id` and `x-client-secret`\n- `app_id` for authenticated api calls i.e using `x-client-id` and `x-client-secret`\n" }, "x-request-id": { "schema": { "type": "string" }, "example": "some-req-id", "description": "Request id for your api call. Is blank or null if no `x-request-id` is sent during the request" } } }, "paths": { "/eligibility/payment_methods": { "post": { "summary": "Get eligible Payment Methods", "description": "Use this API to get eligible Payment Methods", "tags": [ "Eligibility" ], "x-mcp": { "enabled": true }, "operationId": "PGEligibilityFetchPaymentMethods", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "requestBody": { "$ref": "#/components/requestBodies/EligibilityFetchPaymentMethodsRequest" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EligibilityPaymentMethodsEntity" } }, "example": [ { "eligibility": true, "entity_type": "payment_methods", "entity_value": "netbanking", "entity_details": { "payment_method_details": [ { "nick": "motak_kahindra_bank", "display": "Motak Kahindra Bank", "eligibility": true, "code": 3032 }, { "nick": "bank_of_india", "display": "Bank Of India", "eligibility": true, "code": 3031 } ] } } ] } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" }, "502": { "$ref": "#/components/responses/Response502" } } } }, "/links": { "post": { "summary": "Create Payment Link", "x-mcp": { "enabled": true }, "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.", "tags": [ "Payment Links" ], "operationId": "PGCreateLink", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "requestBody": { "$ref": "#/components/requestBodies/CreateLinkRequest" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/links/{link_id}": { "get": { "summary": "Fetch Payment Link Details", "x-mcp": { "enabled": true }, "description": "Use this API to view all details and status of a payment link.", "tags": [ "Payment Links" ], "operationId": "PGFetchLink", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/linkIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" }, "502": { "$ref": "#/components/responses/Response502" } } } }, "/links/{link_id}/cancel": { "post": { "summary": "Cancel Payment Link", "x-mcp": { "enabled": true }, "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.", "tags": [ "Payment Links" ], "operationId": "PGCancelLink", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "$ref": "#/components/parameters/linkIDParam" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/links/{link_id}/orders": { "get": { "summary": "Get Orders for a Payment Link", "x-mcp": { "enabled": true }, "description": "Use this API to view all order details for a payment link.", "tags": [ "Payment Links" ], "operationId": "PGLinkFetchOrders", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/linkIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "$ref": "#/components/parameters/statusQueryParam" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentLinkOrderEntity" } }, "examples": { "order_entity_list_example": { "$ref": "#/components/examples/order_entity_list_example" } } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/orders": { "post": { "summary": "Create Order", "x-mcp": { "enabled": true }, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "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", "tags": [ "Orders" ], "operationId": "PGCreateOrder", "deprecated": false, "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "requestBody": { "$ref": "#/components/requestBodies/CreateOrderRequest" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/orders/{order_id}": { "get": { "summary": "Get Order", "x-mcp": { "enabled": true }, "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", "tags": [ "Orders" ], "operationId": "PGFetchOrder", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } }, "patch": { "summary": "Terminate Order", "description": "Use this API to terminate the order that was created at Cashfree's using the `order_id`.", "tags": [ "Orders" ], "operationId": "PGTerminateOrder", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "requestBody": { "$ref": "#/components/requestBodies/TerminateOrderRequest" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/orders/{order_id}/extended": { "get": { "summary": "Get Order Extended", "x-mcp": { "enabled": true }, "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", "tags": [ "Orders" ], "operationId": "PGFetchOrderExtendedData", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderExtendedDataEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/orders/{order_id}/payments": { "get": { "summary": "Get Payments for an Order", "x-mcp": { "enabled": true }, "description": "Use this API to view all payment details for an order.", "tags": [ "Payments" ], "operationId": "PGOrderFetchPayments", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "description": "List of payment entity", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentEntity" } }, "examples": { "payments_entity_list_example": { "$ref": "#/components/examples/payments_entity_list_example" } } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" }, "502": { "$ref": "#/components/responses/Response502" } } } }, "/orders/{order_id}/payments/{cf_payment_id}": { "get": { "summary": "Get Payment by ID", "x-mcp": { "enabled": true }, "description": "Use this API to view payment details of an order for a Payment ID.", "tags": [ "Payments" ], "operationId": "PGOrderFetchPayment", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/cfPaymentIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" }, "502": { "$ref": "#/components/responses/Response502" } } } }, "/orders/{order_id}/refunds": { "post": { "summary": "Create Refund", "x-mcp": { "enabled": true }, "description": "Use this API to initiate refunds.", "tags": [ "Refunds" ], "operationId": "PGOrderCreateRefund", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "$ref": "#/components/parameters/orderIDParam" } ], "requestBody": { "$ref": "#/components/requestBodies/OrderCreateRefundRequest" }, "responses": { "200": { "description": "Refund created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundEntity" }, "examples": { "refunds_entity_example": { "$ref": "#/components/examples/refunds_entity_example" } } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" }, "502": { "$ref": "#/components/responses/Response502" } } }, "get": { "summary": "Get All Refunds for an Order", "x-mcp": { "enabled": true }, "description": "Use this API to fetch all refunds processed against an order.", "tags": [ "Refunds" ], "operationId": "PGOrderFetchRefunds", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefundEntity" } }, "examples": { "refunds_entity_example": { "$ref": "#/components/examples/refunds_entity_example" } } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/orders/{order_id}/refunds/{refund_id}": { "get": { "summary": "Get Refund", "x-mcp": { "enabled": true }, "description": "Use this API to fetch a specific refund processed on your Cashfree Account.", "tags": [ "Refunds" ], "operationId": "PGOrderFetchRefund", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "in": "path", "name": "refund_id", "description": "Refund Id of the refund you want to fetch.", "required": true, "example": "some-refund-id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" }, "502": { "$ref": "#/components/responses/Response502" } } } }, "/settlements": { "post": { "tags": [ "Settlement Reconciliation" ], "summary": "Get All Settlements", "x-mcp": { "enabled": true }, "operationId": "PGFetchSettlements", "description": "Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range.", "requestBody": { "$ref": "#/components/requestBodies/FetchSettlementsRequest" }, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json", "description": "application/json" }, { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "name": "Accept", "in": "header", "schema": { "type": "string" }, "example": "application/json", "description": "application/json" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/orders/{order_id}/settlements": { "get": { "summary": "Get Settlements by Order ID", "x-mcp": { "enabled": true }, "tags": [ "Settlements" ], "operationId": "PGOrderFetchSettlement", "deprecated": false, "description": "Use this API to view all the settlements of a particular order.", "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/orderIDParam" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" }, "502": { "$ref": "#/components/responses/Response502" } } } }, "/orders/{order_id}/disputes": { "get": { "tags": [ "Disputes" ], "x-mcp": { "enabled": true }, "summary": "Get Disputes by Order Id", "operationId": "PGFetchOrderDisputes", "description": "Use this API to get all Dispute details by specifying the Order ID.", "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "in": "path", "name": "order_id", "required": true, "schema": { "type": "string", "description": "Order or the invoice ID for which you want to view the disputes details." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisputesEntity" } } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/payments/{cf_payment_id}/disputes": { "get": { "tags": [ "Disputes" ], "summary": "Get Disputes by Payment ID", "x-mcp": { "enabled": true }, "operationId": "PGFetchPaymentDisputes", "description": "Use this API to get all Dispute details by specifying the Payment ID.", "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "in": "path", "name": "cf_payment_id", "required": true, "schema": { "type": "integer", "description": "Cashfree Payment ID to view the payment details of an order." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisputesEntity" } } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/disputes/{dispute_id}": { "get": { "tags": [ "Disputes" ], "summary": "Get Disputes by Dispute ID", "x-mcp": { "enabled": true }, "operationId": "PGFetchDisputeByID", "description": "Use this API to get Dispute details by specifying the Dispute ID.", "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "in": "path", "name": "dispute_id", "required": true, "schema": { "type": "integer", "description": "Cashfree dispute ID to view the dispute details of an order." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputesEntity" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/disputes/{dispute_id}/accept": { "put": { "tags": [ "Disputes" ], "summary": "Accept Dispute by Dispute ID", "x-mcp": { "enabled": true }, "operationId": "PGAcceptDisputeByID", "description": "Use this API to get accept the Dispute by specifying the Dispute ID.", "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "in": "path", "name": "dispute_id", "required": true, "schema": { "type": "integer", "description": "Cashfree dispute ID to view the dispute details of an order." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputesEntityMerchantAccepted" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/disputes/{dispute_id}/documents": { "post": { "tags": [ "Disputes" ], "summary": "Submit Evidence to contest the Dispute by Dispute ID", "x-mcp": { "enabled": true }, "operationId": "PGUploadDisputesDocuments", "description": "Use this API to Submit the Evidences to contest the Dispute by specifying the Dispute ID.", "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "in": "path", "name": "dispute_id", "required": true, "schema": { "type": "integer", "description": "Cashfree dispute ID to get Evidences to submit to contest the Dispute." } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file", "doc_type" ], "properties": { "file": { "type": "string", "description": "File types supported are jpeg, jpg, png, pdf and maximum file size allowed is 20 MB." }, "doc_type": { "type": "string", "description": "Mention the type of the document you are uploading. Possible values :- Delivery/Service Proof, Shipping Proof, Statement of Service, Proof of Service Used, Cancellation of Service Proof, Refund Proof, Business model explanation, Extra Charges Declaration, Terms & Conditions, Customer Withdrawal Letter, Certificate of Authenticity, Reseller Agreement. You can use get evidences to contest dispute API to fetch set of documents required to contest particular dispute." }, "note": { "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisputesEntity" } } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" }, "x-idempotency-key": { "$ref": "#/components/headers/x-idempotency-key" }, "x-idempotency-replayed": { "$ref": "#/components/headers/x-idempotency-replayed" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "409": { "$ref": "#/components/responses/Response409" }, "422": { "$ref": "#/components/responses/Response422" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/simulate": { "post": { "summary": "Simulate Payment", "x-mcp": { "enabled": true }, "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.", "tags": [ "Simulation" ], "operationId": "PGSimulatePayment", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "requestBody": { "$ref": "#/components/requestBodies/SimulateRequest" }, "responses": { "200": { "description": "Payment Simulated Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationResponse" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/simulate/{simulation_id}": { "get": { "summary": "Fetch Simulation", "x-mcp": { "enabled": true }, "description": "Use this API to fetch simulated payment details.", "tags": [ "Simulation" ], "operationId": "PGFetchSimulation", "deprecated": false, "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" }, { "in": "path", "name": "simulation_id", "example": "sim_2900842gV18Lhh7owswLj5XF0uHHUn1CX", "required": true, "description": "Provide the SimulationId for which the details have to be fetched.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Fetched Simulated Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationResponse" } } }, "headers": { "x-api-version": { "$ref": "#/components/headers/x-api-version" }, "x-ratelimit-limit": { "$ref": "#/components/headers/x-ratelimit-limit" }, "x-ratelimit-remaining": { "$ref": "#/components/headers/x-ratelimit-remaining" }, "x-ratelimit-retry": { "$ref": "#/components/headers/x-ratelimit-retry" }, "x-ratelimit-type": { "$ref": "#/components/headers/x-ratelimit-type" }, "x-request-id": { "$ref": "#/components/headers/x-request-id" } } }, "400": { "$ref": "#/components/responses/Response400" }, "401": { "$ref": "#/components/responses/Response401" }, "404": { "$ref": "#/components/responses/Response404" }, "429": { "$ref": "#/components/responses/Response429" }, "500": { "$ref": "#/components/responses/Response500" } } } }, "/split/order/vendor/recon": { "post": { "summary": "Get Split and Settlement Details by OrderID v2.0", "x-mcp": { "enabled": true }, "tags": [ "Easy-Split" ], "operationId": "PGESOrderRecon", "deprecated": false, "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.", "security": [ { "XClientID": [], "XClientSecret": [] }, { "XClientID": [], "XPartnerAPIKey": [] }, { "XClientID": [], "XClientSignatureHeader": [] }, { "XPartnerMerchantID": [], "XPartnerAPIKey": [] } ], "requestBody": { "$ref": "#/components/requestBodies/ESOrderReconRequestBody" }, "parameters": [ { "$ref": "#/components/parameters/apiVersionHeader" }, { "$ref": "#/components/parameters/xRequestIDHeader" }, { "$ref": "#/components/parameters/xIdempotencyKeyHeader" } ], "responses": { "200": { "$ref": "#/components/responses/ESOrderReconSuccessResponse" }, "400": { "$ref": "#/components/responses/Response400ESOrderRecon" }, "404": { "$ref": "#/components/responses/Response404ESOrderRecon" }, "409": { "$ref": "#/components/responses/Response409ESOrderRecon" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true, "samples-languages": [ "shell" ] } }