From b123ef8463d5a5f7435c00755f1cb35d4fd2504c Mon Sep 17 00:00:00 2001 From: Venkatanaga Sudheer Kumar Date: Thu, 4 Apr 2024 18:19:18 +0530 Subject: [PATCH 1/3] documentation --- .gitignore | 3 +- docs/AdjustVendorBalanceRequest.md | 15 - docs/AdjustVendorBalanceResponse.md | 14 - docs/ApiError.md | 13 - docs/ApiError404.md | 13 - docs/ApiError409.md | 13 - docs/ApiError502.md | 13 - docs/App.md | 13 - docs/AppPaymentMethod.md | 11 - docs/AuthenticationError.md | 13 - docs/AuthorizationInPaymentsEntity.md | 18 - docs/AuthorizeOrderRequest.md | 12 - docs/BadRequestError.md | 13 - docs/BalanceDetails.md | 13 - docs/BankDetails.md | 12 - docs/Banktransfer.md | 11 - docs/BanktransferPaymentMethod.md | 11 - docs/Card.md | 25 - docs/CardEMI.md | 19 - docs/CardEMIPaymentMethod.md | 11 - docs/CardOffer.md | 12 - docs/CardPaymentMethod.md | 11 - docs/CardlessEMI.md | 14 - docs/CardlessEMIEntity.md | 12 - docs/CardlessEMIPaymentMethod.md | 11 - docs/CardlessEMIQueries.md | 13 - docs/CashbackDetails.md | 13 - docs/ChargesDetails.md | 14 - docs/CreateCustomerRequest.md | 13 - docs/CreateLinkRequest.md | 23 - docs/CreateOfferRequest.md | 14 - docs/CreateOrderRequest.md | 20 - docs/CreateOrderRequestOrderMeta.md | 12 - docs/CreateOrderRequestTerminal.md | 19 - docs/CreateTerminalRequest.md | 18 - docs/CreateTerminalRequestTerminalMeta.md | 11 - docs/CreateTerminalTransactionRequest.md | 14 - docs/CreateVendorRequest.md | 21 - docs/CreateVendorResponse.md | 21 - docs/CryptogramEntity.md | 17 - docs/CustomerDetails.md | 18 - docs/CustomerDetailsCardlessEMI.md | 11 - docs/CustomerEntity.md | 14 - docs/CustomersApi.md | 97 -- docs/DiscountDetails.md | 13 - docs/EMIOffer.md | 12 - docs/EMIPlansArray.md | 16 - docs/ESOrderReconRequest.md | 12 - docs/ESOrderReconRequestFilters.md | 13 - docs/ESOrderReconRequestPagination.md | 12 - docs/ESOrderReconResponse.md | 13 - docs/ESOrderReconResponseDataInner.md | 35 - ...rReconResponseDataInnerOrderSplitsInner.md | 11 - ...onseDataInnerOrderSplitsInnerSplitInner.md | 12 - docs/EasySplitApi.md | 1034 ----------------- docs/EligibilityApi.md | 370 ------ docs/EligibilityCardlessEMIEntity.md | 14 - docs/EligibilityFetchCardlessEMIRequest.md | 11 - docs/EligibilityFetchOffersRequest.md | 12 - docs/EligibilityFetchPaylaterRequest.md | 11 - docs/EligibilityFetchPaymentMethodsRequest.md | 12 - docs/EligibilityOfferEntity.md | 14 - docs/EligibilityPaylaterEntity.md | 14 - docs/EligibilityPaymentMethodsEntity.md | 14 - ...bilityPaymentMethodsEntityEntityDetails.md | 10 - docs/ErrorDetailsInPaymentsEntity.md | 17 - docs/FetchReconRequest.md | 12 - docs/FetchReconRequestFilters.md | 11 - docs/FetchReconRequestPagination.md | 12 - docs/FetchSettlementsRequest.md | 12 - docs/FetchSettlementsRequestFilters.md | 14 - docs/FetchSettlementsRequestPagination.md | 12 - docs/FetchTerminalQRCodesEntity.md | 14 - docs/IdempotencyError.md | 13 - docs/InstrumentEntity.md | 19 - docs/InstrumentWebhook.md | 11 - docs/InstrumentWebhookData.md | 12 - docs/InstrumentWebhookDataEntity.md | 11 - docs/KycDetails.md | 18 - docs/LinkCustomerDetailsEntity.md | 13 - docs/LinkEntity.md | 29 - docs/LinkMetaEntity.md | 14 - docs/LinkMetaResponseEntity.md | 14 - docs/LinkNotifyEntity.md | 12 - docs/NetBankingPaymentMethod.md | 11 - docs/Netbanking.md | 13 - docs/OfferAll.md | 11 - docs/OfferCard.md | 11 - docs/OfferDetails.md | 13 - docs/OfferEMI.md | 11 - docs/OfferEntity.md | 16 - docs/OfferFilters.md | 11 - docs/OfferMeta.md | 15 - docs/OfferNB.md | 11 - docs/OfferNBNetbanking.md | 10 - docs/OfferPaylater.md | 11 - docs/OfferQueries.md | 12 - docs/OfferTnc.md | 12 - docs/OfferType.md | 10 - docs/OfferUPI.md | 11 - docs/OfferValidations.md | 13 - docs/OfferValidationsPaymentMethod.md | 16 - docs/OfferWallet.md | 11 - docs/Offers.md | 258 ++++ docs/OffersApi.md | 187 --- docs/OrderAuthenticateEntity.md | 14 - docs/OrderAuthenticatePaymentRequest.md | 12 - docs/OrderCreateRefundRequest.md | 15 - docs/OrderEntity.md | 24 - docs/OrderMeta.md | 13 - docs/OrderPayData.md | 14 - docs/Orders.md | 236 ++++ docs/OrdersApi.md | 279 ----- docs/PGReconciliationApi.md | 101 -- docs/PayOrderEntity.md | 16 - docs/PayOrderRequest.md | 14 - docs/PayOrderRequestPaymentMethod.md | 17 - docs/Paylater.md | 13 - docs/PaylaterEntity.md | 11 - docs/PaylaterOffer.md | 10 - docs/PaylaterPaymentMethod.md | 11 - docs/PaymentEntity.md | 27 - docs/PaymentEntityPaymentMethod.md | 17 - docs/PaymentLinkCustomerDetails.md | 17 - docs/PaymentLinkOrderEntity.md | 25 - docs/PaymentLinksApi.md | 368 ------ docs/PaymentMethodAppInPaymentsEntity.md | 11 - docs/PaymentMethodAppInPaymentsEntityApp.md | 12 - ...ymentMethodBankTransferInPaymentsEntity.md | 11 - ...ankTransferInPaymentsEntityBanktransfer.md | 13 - docs/PaymentMethodCardEMIInPaymentsEntity.md | 11 - ...PaymentMethodCardEMIInPaymentsEntityEmi.md | 18 - ...hodCardEMIInPaymentsEntityEmiEmiDetails.md | 12 - docs/PaymentMethodCardInPaymentsEntity.md | 11 - docs/PaymentMethodCardInPaymentsEntityCard.md | 16 - ...aymentMethodCardlessEMIInPaymentsEntity.md | 11 - docs/PaymentMethodInPaymentsEntity.md | 11 - ...mentMethodInPaymentsEntityPaymentMethod.md | 16 - ...PaymentMethodNetBankingInPaymentsEntity.md | 11 - ...hodNetBankingInPaymentsEntityNetbanking.md | 14 - docs/PaymentMethodPaylaterInPaymentsEntity.md | 11 - docs/PaymentMethodUPIInPaymentsEntity.md | 11 - docs/PaymentMethodUPIInPaymentsEntityUpi.md | 11 - docs/PaymentMethodsFilters.md | 11 - docs/PaymentMethodsQueries.md | 12 - docs/PaymentModeDetails.md | 14 - docs/PaymentSuccessWebhook.md | 13 - docs/PaymentURLObject.md | 11 - docs/PaymentWebhook.md | 13 - docs/PaymentWebhookCustomerEntity.md | 14 - docs/PaymentWebhookDataEntity.md | 16 - docs/PaymentWebhookDataEntity1.md | 11 - docs/PaymentWebhookErrorEntity.md | 16 - docs/PaymentWebhookGatewayDetailsEntity.md | 15 - docs/PaymentWebhookOrderEntity.md | 14 - docs/PaymentsApi.md | 468 -------- docs/RateLimitError.md | 13 - docs/ReconEntity.md | 13 - docs/ReconEntityDataInner.md | 56 - docs/Reconciliation.md | 280 +++++ docs/RefundEntity.md | 29 - docs/RefundSpeed.md | 14 - docs/RefundURLObject.md | 11 - docs/RefundWebhook.md | 13 - docs/RefundWebhookDataEntity.md | 11 - docs/RefundsApi.md | 283 ----- docs/SavedInstrumentMeta.md | 15 - docs/ScheduleOption.md | 12 - docs/SettlementEntity.md | 24 - docs/SettlementFetchReconRequest.md | 12 - docs/SettlementFetchReconRequestFilters.md | 14 - docs/SettlementReconEntity.md | 13 - docs/SettlementReconEntityDataInner.md | 44 - docs/SettlementReconciliationApi.md | 195 ---- docs/SettlementURLObject.md | 11 - docs/SettlementWebhook.md | 13 - docs/SettlementWebhookDataEntity.md | 11 - docs/Settlements.md | 89 ++ docs/SettlementsApi.md | 98 -- docs/SoftPOSApi.md | 737 ------------ docs/SplitAfterPaymentRequest.md | 12 - docs/SplitAfterPaymentRequestSplitInner.md | 13 - ...tAfterPaymentRequestSplitInnerTagsInner.md | 11 - docs/SplitAfterPaymentResponse.md | 12 - docs/StaticSplitRequest.md | 15 - docs/StaticSplitRequestSchemeInner.md | 11 - docs/StaticSplitResponse.md | 16 - docs/StaticSplitResponseSchemeInner.md | 11 - docs/TerminalDetails.md | 20 - docs/TerminalEntity.md | 22 - docs/TerminalPaymentEntity.md | 28 - docs/TerminalTransactionEntity.md | 16 - docs/TerminateOrderRequest.md | 11 - docs/TokenVaultApi.md | 378 ------ docs/TransferDetails.md | 15 - docs/TransferDetailsTagsInner.md | 11 - docs/UPIAuthorizeDetails.md | 13 - docs/UPIPaymentMethod.md | 11 - docs/UpdateTerminalEntity.md | 22 - docs/UpdateTerminalRequest.md | 14 - docs/UpdateTerminalRequestTerminalMeta.md | 11 - docs/UpdateTerminalStatusRequest.md | 11 - docs/UpdateVendorRequest.md | 20 - docs/UpdateVendorResponse.md | 27 - docs/Upi.md | 16 - docs/UpiDetails.md | 11 - docs/UploadTerminalDocs.md | 13 - docs/UploadTerminalDocsEntity.md | 14 - docs/UploadVendorDocsRequest.md | 13 - docs/UploadVendorDocumentsResponse.md | 15 - docs/VendorBalance.md | 14 - docs/VendorBalanceTransferCharges.md | 15 - docs/VendorDocumentDownloadResponse.md | 11 - docs/VendorDocumentsResponse.md | 11 - docs/VendorEntity.md | 24 - docs/VendorEntityRelatedDocsInner.md | 14 - docs/VendorSplit.md | 14 - docs/WHcustomerDetails.md | 14 - docs/WHdata.md | 13 - docs/WHorder.md | 14 - docs/WalletOffer.md | 10 - 221 files changed, 865 insertions(+), 7524 deletions(-) delete mode 100644 docs/AdjustVendorBalanceRequest.md delete mode 100644 docs/AdjustVendorBalanceResponse.md delete mode 100644 docs/ApiError.md delete mode 100644 docs/ApiError404.md delete mode 100644 docs/ApiError409.md delete mode 100644 docs/ApiError502.md delete mode 100644 docs/App.md delete mode 100644 docs/AppPaymentMethod.md delete mode 100644 docs/AuthenticationError.md delete mode 100644 docs/AuthorizationInPaymentsEntity.md delete mode 100644 docs/AuthorizeOrderRequest.md delete mode 100644 docs/BadRequestError.md delete mode 100644 docs/BalanceDetails.md delete mode 100644 docs/BankDetails.md delete mode 100644 docs/Banktransfer.md delete mode 100644 docs/BanktransferPaymentMethod.md delete mode 100644 docs/Card.md delete mode 100644 docs/CardEMI.md delete mode 100644 docs/CardEMIPaymentMethod.md delete mode 100644 docs/CardOffer.md delete mode 100644 docs/CardPaymentMethod.md delete mode 100644 docs/CardlessEMI.md delete mode 100644 docs/CardlessEMIEntity.md delete mode 100644 docs/CardlessEMIPaymentMethod.md delete mode 100644 docs/CardlessEMIQueries.md delete mode 100644 docs/CashbackDetails.md delete mode 100644 docs/ChargesDetails.md delete mode 100644 docs/CreateCustomerRequest.md delete mode 100644 docs/CreateLinkRequest.md delete mode 100644 docs/CreateOfferRequest.md delete mode 100644 docs/CreateOrderRequest.md delete mode 100644 docs/CreateOrderRequestOrderMeta.md delete mode 100644 docs/CreateOrderRequestTerminal.md delete mode 100644 docs/CreateTerminalRequest.md delete mode 100644 docs/CreateTerminalRequestTerminalMeta.md delete mode 100644 docs/CreateTerminalTransactionRequest.md delete mode 100644 docs/CreateVendorRequest.md delete mode 100644 docs/CreateVendorResponse.md delete mode 100644 docs/CryptogramEntity.md delete mode 100644 docs/CustomerDetails.md delete mode 100644 docs/CustomerDetailsCardlessEMI.md delete mode 100644 docs/CustomerEntity.md delete mode 100644 docs/CustomersApi.md delete mode 100644 docs/DiscountDetails.md delete mode 100644 docs/EMIOffer.md delete mode 100644 docs/EMIPlansArray.md delete mode 100644 docs/ESOrderReconRequest.md delete mode 100644 docs/ESOrderReconRequestFilters.md delete mode 100644 docs/ESOrderReconRequestPagination.md delete mode 100644 docs/ESOrderReconResponse.md delete mode 100644 docs/ESOrderReconResponseDataInner.md delete mode 100644 docs/ESOrderReconResponseDataInnerOrderSplitsInner.md delete mode 100644 docs/ESOrderReconResponseDataInnerOrderSplitsInnerSplitInner.md delete mode 100644 docs/EasySplitApi.md delete mode 100644 docs/EligibilityApi.md delete mode 100644 docs/EligibilityCardlessEMIEntity.md delete mode 100644 docs/EligibilityFetchCardlessEMIRequest.md delete mode 100644 docs/EligibilityFetchOffersRequest.md delete mode 100644 docs/EligibilityFetchPaylaterRequest.md delete mode 100644 docs/EligibilityFetchPaymentMethodsRequest.md delete mode 100644 docs/EligibilityOfferEntity.md delete mode 100644 docs/EligibilityPaylaterEntity.md delete mode 100644 docs/EligibilityPaymentMethodsEntity.md delete mode 100644 docs/EligibilityPaymentMethodsEntityEntityDetails.md delete mode 100644 docs/ErrorDetailsInPaymentsEntity.md delete mode 100644 docs/FetchReconRequest.md delete mode 100644 docs/FetchReconRequestFilters.md delete mode 100644 docs/FetchReconRequestPagination.md delete mode 100644 docs/FetchSettlementsRequest.md delete mode 100644 docs/FetchSettlementsRequestFilters.md delete mode 100644 docs/FetchSettlementsRequestPagination.md delete mode 100644 docs/FetchTerminalQRCodesEntity.md delete mode 100644 docs/IdempotencyError.md delete mode 100644 docs/InstrumentEntity.md delete mode 100644 docs/InstrumentWebhook.md delete mode 100644 docs/InstrumentWebhookData.md delete mode 100644 docs/InstrumentWebhookDataEntity.md delete mode 100644 docs/KycDetails.md delete mode 100644 docs/LinkCustomerDetailsEntity.md delete mode 100644 docs/LinkEntity.md delete mode 100644 docs/LinkMetaEntity.md delete mode 100644 docs/LinkMetaResponseEntity.md delete mode 100644 docs/LinkNotifyEntity.md delete mode 100644 docs/NetBankingPaymentMethod.md delete mode 100644 docs/Netbanking.md delete mode 100644 docs/OfferAll.md delete mode 100644 docs/OfferCard.md delete mode 100644 docs/OfferDetails.md delete mode 100644 docs/OfferEMI.md delete mode 100644 docs/OfferEntity.md delete mode 100644 docs/OfferFilters.md delete mode 100644 docs/OfferMeta.md delete mode 100644 docs/OfferNB.md delete mode 100644 docs/OfferNBNetbanking.md delete mode 100644 docs/OfferPaylater.md delete mode 100644 docs/OfferQueries.md delete mode 100644 docs/OfferTnc.md delete mode 100644 docs/OfferType.md delete mode 100644 docs/OfferUPI.md delete mode 100644 docs/OfferValidations.md delete mode 100644 docs/OfferValidationsPaymentMethod.md delete mode 100644 docs/OfferWallet.md create mode 100644 docs/Offers.md delete mode 100644 docs/OffersApi.md delete mode 100644 docs/OrderAuthenticateEntity.md delete mode 100644 docs/OrderAuthenticatePaymentRequest.md delete mode 100644 docs/OrderCreateRefundRequest.md delete mode 100644 docs/OrderEntity.md delete mode 100644 docs/OrderMeta.md delete mode 100644 docs/OrderPayData.md create mode 100644 docs/Orders.md delete mode 100644 docs/OrdersApi.md delete mode 100644 docs/PGReconciliationApi.md delete mode 100644 docs/PayOrderEntity.md delete mode 100644 docs/PayOrderRequest.md delete mode 100644 docs/PayOrderRequestPaymentMethod.md delete mode 100644 docs/Paylater.md delete mode 100644 docs/PaylaterEntity.md delete mode 100644 docs/PaylaterOffer.md delete mode 100644 docs/PaylaterPaymentMethod.md delete mode 100644 docs/PaymentEntity.md delete mode 100644 docs/PaymentEntityPaymentMethod.md delete mode 100644 docs/PaymentLinkCustomerDetails.md delete mode 100644 docs/PaymentLinkOrderEntity.md delete mode 100644 docs/PaymentLinksApi.md delete mode 100644 docs/PaymentMethodAppInPaymentsEntity.md delete mode 100644 docs/PaymentMethodAppInPaymentsEntityApp.md delete mode 100644 docs/PaymentMethodBankTransferInPaymentsEntity.md delete mode 100644 docs/PaymentMethodBankTransferInPaymentsEntityBanktransfer.md delete mode 100644 docs/PaymentMethodCardEMIInPaymentsEntity.md delete mode 100644 docs/PaymentMethodCardEMIInPaymentsEntityEmi.md delete mode 100644 docs/PaymentMethodCardEMIInPaymentsEntityEmiEmiDetails.md delete mode 100644 docs/PaymentMethodCardInPaymentsEntity.md delete mode 100644 docs/PaymentMethodCardInPaymentsEntityCard.md delete mode 100644 docs/PaymentMethodCardlessEMIInPaymentsEntity.md delete mode 100644 docs/PaymentMethodInPaymentsEntity.md delete mode 100644 docs/PaymentMethodInPaymentsEntityPaymentMethod.md delete mode 100644 docs/PaymentMethodNetBankingInPaymentsEntity.md delete mode 100644 docs/PaymentMethodNetBankingInPaymentsEntityNetbanking.md delete mode 100644 docs/PaymentMethodPaylaterInPaymentsEntity.md delete mode 100644 docs/PaymentMethodUPIInPaymentsEntity.md delete mode 100644 docs/PaymentMethodUPIInPaymentsEntityUpi.md delete mode 100644 docs/PaymentMethodsFilters.md delete mode 100644 docs/PaymentMethodsQueries.md delete mode 100644 docs/PaymentModeDetails.md delete mode 100644 docs/PaymentSuccessWebhook.md delete mode 100644 docs/PaymentURLObject.md delete mode 100644 docs/PaymentWebhook.md delete mode 100644 docs/PaymentWebhookCustomerEntity.md delete mode 100644 docs/PaymentWebhookDataEntity.md delete mode 100644 docs/PaymentWebhookDataEntity1.md delete mode 100644 docs/PaymentWebhookErrorEntity.md delete mode 100644 docs/PaymentWebhookGatewayDetailsEntity.md delete mode 100644 docs/PaymentWebhookOrderEntity.md delete mode 100644 docs/PaymentsApi.md delete mode 100644 docs/RateLimitError.md delete mode 100644 docs/ReconEntity.md delete mode 100644 docs/ReconEntityDataInner.md create mode 100644 docs/Reconciliation.md delete mode 100644 docs/RefundEntity.md delete mode 100644 docs/RefundSpeed.md delete mode 100644 docs/RefundURLObject.md delete mode 100644 docs/RefundWebhook.md delete mode 100644 docs/RefundWebhookDataEntity.md delete mode 100644 docs/RefundsApi.md delete mode 100644 docs/SavedInstrumentMeta.md delete mode 100644 docs/ScheduleOption.md delete mode 100644 docs/SettlementEntity.md delete mode 100644 docs/SettlementFetchReconRequest.md delete mode 100644 docs/SettlementFetchReconRequestFilters.md delete mode 100644 docs/SettlementReconEntity.md delete mode 100644 docs/SettlementReconEntityDataInner.md delete mode 100644 docs/SettlementReconciliationApi.md delete mode 100644 docs/SettlementURLObject.md delete mode 100644 docs/SettlementWebhook.md delete mode 100644 docs/SettlementWebhookDataEntity.md create mode 100644 docs/Settlements.md delete mode 100644 docs/SettlementsApi.md delete mode 100644 docs/SoftPOSApi.md delete mode 100644 docs/SplitAfterPaymentRequest.md delete mode 100644 docs/SplitAfterPaymentRequestSplitInner.md delete mode 100644 docs/SplitAfterPaymentRequestSplitInnerTagsInner.md delete mode 100644 docs/SplitAfterPaymentResponse.md delete mode 100644 docs/StaticSplitRequest.md delete mode 100644 docs/StaticSplitRequestSchemeInner.md delete mode 100644 docs/StaticSplitResponse.md delete mode 100644 docs/StaticSplitResponseSchemeInner.md delete mode 100644 docs/TerminalDetails.md delete mode 100644 docs/TerminalEntity.md delete mode 100644 docs/TerminalPaymentEntity.md delete mode 100644 docs/TerminalTransactionEntity.md delete mode 100644 docs/TerminateOrderRequest.md delete mode 100644 docs/TokenVaultApi.md delete mode 100644 docs/TransferDetails.md delete mode 100644 docs/TransferDetailsTagsInner.md delete mode 100644 docs/UPIAuthorizeDetails.md delete mode 100644 docs/UPIPaymentMethod.md delete mode 100644 docs/UpdateTerminalEntity.md delete mode 100644 docs/UpdateTerminalRequest.md delete mode 100644 docs/UpdateTerminalRequestTerminalMeta.md delete mode 100644 docs/UpdateTerminalStatusRequest.md delete mode 100644 docs/UpdateVendorRequest.md delete mode 100644 docs/UpdateVendorResponse.md delete mode 100644 docs/Upi.md delete mode 100644 docs/UpiDetails.md delete mode 100644 docs/UploadTerminalDocs.md delete mode 100644 docs/UploadTerminalDocsEntity.md delete mode 100644 docs/UploadVendorDocsRequest.md delete mode 100644 docs/UploadVendorDocumentsResponse.md delete mode 100644 docs/VendorBalance.md delete mode 100644 docs/VendorBalanceTransferCharges.md delete mode 100644 docs/VendorDocumentDownloadResponse.md delete mode 100644 docs/VendorDocumentsResponse.md delete mode 100644 docs/VendorEntity.md delete mode 100644 docs/VendorEntityRelatedDocsInner.md delete mode 100644 docs/VendorSplit.md delete mode 100644 docs/WHcustomerDetails.md delete mode 100644 docs/WHdata.md delete mode 100644 docs/WHorder.md delete mode 100644 docs/WalletOffer.md diff --git a/.gitignore b/.gitignore index 187b296..a41abd3 100644 --- a/.gitignore +++ b/.gitignore @@ -366,4 +366,5 @@ src/cashfree_pg/Api/ src/cashfree_pg.Test/ .DS_Store */.DS_Store -*/*/.DS_Store \ No newline at end of file +*/*/.DS_Store +.idea/ \ No newline at end of file diff --git a/docs/AdjustVendorBalanceRequest.md b/docs/AdjustVendorBalanceRequest.md deleted file mode 100644 index 30f2f66..0000000 --- a/docs/AdjustVendorBalanceRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.AdjustVendorBalanceRequest -Adjust Vendor Balance Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transfer_from** | **string** | Mention to whom you want to transfer the on demand balance. Possible values - MERCHANT, VENDOR. | -**transfer_type** | **string** | Mention the type of transfer. Possible values: ON_DEMAND. | -**transfer_amount** | **decimal** | Mention the on demand transfer amount. | -**remark** | **string** | Mention remarks if any for the on demand transfer. | [optional] -**tags** | **Object** | Provide additional data fields using tags. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AdjustVendorBalanceResponse.md b/docs/AdjustVendorBalanceResponse.md deleted file mode 100644 index 2ffc5ea..0000000 --- a/docs/AdjustVendorBalanceResponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.AdjustVendorBalanceResponse -Adjust Vendor Balance Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**settlement_id** | **decimal** | | [optional] -**transfer_details** | [**TransferDetails**](TransferDetails.md) | | [optional] -**balances** | [**BalanceDetails**](BalanceDetails.md) | | [optional] -**charges** | [**ChargesDetails**](ChargesDetails.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ApiError.md b/docs/ApiError.md deleted file mode 100644 index ecc7ee6..0000000 --- a/docs/ApiError.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.ApiError -Error at cashfree's server - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | | [optional] -**type** | **string** | api_error | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ApiError404.md b/docs/ApiError404.md deleted file mode 100644 index 457fc63..0000000 --- a/docs/ApiError404.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.ApiError404 -Error when resource requested is not found - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | | [optional] -**type** | **string** | invalid_request_error | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ApiError409.md b/docs/ApiError409.md deleted file mode 100644 index e5296d5..0000000 --- a/docs/ApiError409.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.ApiError409 -duplicate request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | | [optional] -**type** | **string** | invalid_request_error | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ApiError502.md b/docs/ApiError502.md deleted file mode 100644 index 5112386..0000000 --- a/docs/ApiError502.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.ApiError502 -Error when there is error at partner bank - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | `bank_processing_failure` will be returned here to denote failure at bank. | [optional] -**type** | **string** | api_error | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/App.md b/docs/App.md deleted file mode 100644 index 4f29e08..0000000 --- a/docs/App.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.App -App payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | Specify the channel through which the payment must be processed. | -**provider** | **string** | Specify the provider through which the payment must be processed. | -**phone** | **string** | Customer phone number associated with a wallet for payment. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AppPaymentMethod.md b/docs/AppPaymentMethod.md deleted file mode 100644 index be569c0..0000000 --- a/docs/AppPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.AppPaymentMethod -App payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**app** | [**App**](App.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AuthenticationError.md b/docs/AuthenticationError.md deleted file mode 100644 index b481d7d..0000000 --- a/docs/AuthenticationError.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.AuthenticationError -Error if api keys are wrong - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | | [optional] -**type** | **string** | authentication_error | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AuthorizationInPaymentsEntity.md b/docs/AuthorizationInPaymentsEntity.md deleted file mode 100644 index 69f12d0..0000000 --- a/docs/AuthorizationInPaymentsEntity.md +++ /dev/null @@ -1,18 +0,0 @@ -# cashfree_pg.Model.AuthorizationInPaymentsEntity -If preauth enabled for account you will get this body - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**action** | **string** | One of CAPTURE or VOID | [optional] -**status** | **string** | One of SUCCESS or PENDING | [optional] -**captured_amount** | **decimal** | The captured amount for this authorization request | [optional] -**start_time** | **string** | Start time of this authorization hold (only for UPI) | [optional] -**end_time** | **string** | End time of this authorization hold (only for UPI) | [optional] -**approve_by** | **string** | Approve by time as passed in the authorization request (only for UPI) | [optional] -**action_reference** | **string** | CAPTURE or VOID reference number based on action | [optional] -**action_time** | **string** | Time of action (CAPTURE or VOID) | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AuthorizeOrderRequest.md b/docs/AuthorizeOrderRequest.md deleted file mode 100644 index ff15a39..0000000 --- a/docs/AuthorizeOrderRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.AuthorizeOrderRequest -Request to capture or void transaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**action** | **string** | Type of authorization to run. Can be one of 'CAPTURE' , 'VOID' | [optional] -**amount** | **decimal** | The amount if you are running a 'CAPTURE' | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BadRequestError.md b/docs/BadRequestError.md deleted file mode 100644 index 0ce474c..0000000 --- a/docs/BadRequestError.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.BadRequestError -Invalid request received from client - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | | [optional] -**type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BalanceDetails.md b/docs/BalanceDetails.md deleted file mode 100644 index 08a14e8..0000000 --- a/docs/BalanceDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.BalanceDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_id** | **decimal** | | [optional] -**vendor_id** | **string** | | [optional] -**merchant_unsettled** | **decimal** | | [optional] -**vendor_unsettled** | **decimal** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BankDetails.md b/docs/BankDetails.md deleted file mode 100644 index fcc6b89..0000000 --- a/docs/BankDetails.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.BankDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_number** | **string** | | [optional] -**account_holder** | **string** | | [optional] -**ifsc** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Banktransfer.md b/docs/Banktransfer.md deleted file mode 100644 index 1f35bda..0000000 --- a/docs/Banktransfer.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.Banktransfer -Banktransfer payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | The channel for cardless EMI is always `link` | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BanktransferPaymentMethod.md b/docs/BanktransferPaymentMethod.md deleted file mode 100644 index 6e078d8..0000000 --- a/docs/BanktransferPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.BanktransferPaymentMethod -banktransfer payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**banktransfer** | [**Banktransfer**](Banktransfer.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Card.md b/docs/Card.md deleted file mode 100644 index 7b90853..0000000 --- a/docs/Card.md +++ /dev/null @@ -1,25 +0,0 @@ -# cashfree_pg.Model.Card -Card Payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | 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** | **string** | Customer card number for plain card transactions. Token pan number for tokenized card transactions. | [optional] -**card_holder_name** | **string** | Customer name mentioned on the card. | [optional] -**card_expiry_mm** | **string** | Card expiry month for plain card transactions. Token expiry month for tokenized card transactions. | [optional] -**card_expiry_yy** | **string** | Card expiry year for plain card transactions. Token expiry year for tokenized card transactions. | [optional] -**card_cvv** | **string** | CVV mentioned on the card. | [optional] -**instrument_id** | **string** | instrument id of saved card. Required only to make payment using saved instrument. | [optional] -**cryptogram** | **string** | cryptogram received from card network. Required only for tokenized card transactions. | [optional] -**token_requestor_id** | **string** | TRID issued by card networks. Required only for tokenized card transactions. | [optional] -**token_reference_id** | **string** | Token Reference Id provided by Diners for Guest Checkout Token. Required only for Diners cards. | [optional] -**token_type** | **string** | | [optional] -**card_display** | **string** | last 4 digits of original card number. Required only for tokenized card transactions. | [optional] -**card_alias** | **string** | Card alias as returned by Cashfree Vault API. | [optional] -**card_bank_name** | **string** | One of [\"Kotak\", \"ICICI\", \"RBL\", \"BOB\", \"Standard Chartered\"]. Card bank name, required for EMI payments. This is the bank user has selected for EMI | [optional] -**emi_tenure** | **int** | EMI tenure selected by the user | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardEMI.md b/docs/CardEMI.md deleted file mode 100644 index 0bb97af..0000000 --- a/docs/CardEMI.md +++ /dev/null @@ -1,19 +0,0 @@ -# cashfree_pg.Model.CardEMI -Payment method for card emi - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | The channel for card payments will always be \"link\" | -**card_number** | **string** | Customer card number. | -**card_holder_name** | **string** | Customer name mentioned on the card. | [optional] -**card_expiry_mm** | **string** | Card expiry month. | -**card_expiry_yy** | **string** | Card expiry year. | -**card_cvv** | **string** | CVV mentioned on the card. | -**card_alias** | **string** | Card alias as returned by Cashfree Vault API | [optional] -**card_bank_name** | **string** | 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** | **int** | EMI tenure selected by the user | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardEMIPaymentMethod.md b/docs/CardEMIPaymentMethod.md deleted file mode 100644 index b78dae2..0000000 --- a/docs/CardEMIPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.CardEMIPaymentMethod -Complete card emi payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emi** | [**CardEMI**](CardEMI.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardOffer.md b/docs/CardOffer.md deleted file mode 100644 index 12c8d24..0000000 --- a/docs/CardOffer.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.CardOffer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **List<string>** | | -**bank_name** | **string** | Bank Name of Card. | -**scheme_name** | **List<string>** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardPaymentMethod.md b/docs/CardPaymentMethod.md deleted file mode 100644 index 2ca1ad7..0000000 --- a/docs/CardPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.CardPaymentMethod -The card payment object is used to make payment using either plain card number, saved card instrument id or using cryptogram - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**Card**](Card.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardlessEMI.md b/docs/CardlessEMI.md deleted file mode 100644 index 2a46f17..0000000 --- a/docs/CardlessEMI.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.CardlessEMI -Request body for cardless emi payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | The channel for cardless EMI is always `link` | [optional] -**provider** | **string** | One of [`flexmoney`, `zestmoney`, `hdfc`, `icici`, `cashe`, `idfc`, `kotak`] | [optional] -**phone** | **string** | 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' | [optional] -**emi_tenure** | **int** | EMI tenure for the selected provider. This is mandatory when provider is one of [`hdfc`, `icici`, `cashe`, `idfc`, `kotak`] | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardlessEMIEntity.md b/docs/CardlessEMIEntity.md deleted file mode 100644 index 35b6c24..0000000 --- a/docs/CardlessEMIEntity.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.CardlessEMIEntity -cardless EMI object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_method** | **string** | | [optional] -**emi_plans** | [**List<EMIPlansArray>**](EMIPlansArray.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardlessEMIPaymentMethod.md b/docs/CardlessEMIPaymentMethod.md deleted file mode 100644 index 51029ca..0000000 --- a/docs/CardlessEMIPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.CardlessEMIPaymentMethod -cardless EMI payment method object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cardless_emi** | [**CardlessEMI**](CardlessEMI.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardlessEMIQueries.md b/docs/CardlessEMIQueries.md deleted file mode 100644 index cc75de0..0000000 --- a/docs/CardlessEMIQueries.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.CardlessEMIQueries -cardless EMI query object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order_id** | **string** | OrderId of the order. Either of `order_id` or `amount` is mandatory. | [optional] -**amount** | **decimal** | Amount of the order. OrderId of the order. Either of `order_id` or `amount` is mandatory. | [optional] -**customer_details** | [**CustomerDetailsCardlessEMI**](CustomerDetailsCardlessEMI.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CashbackDetails.md b/docs/CashbackDetails.md deleted file mode 100644 index b1815ba..0000000 --- a/docs/CashbackDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.CashbackDetails -Cashback detail boject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cashback_type** | **string** | Type of discount | -**cashback_value** | **decimal** | Value of Discount. | -**max_cashback_amount** | **decimal** | Maximum Value of Cashback allowed. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ChargesDetails.md b/docs/ChargesDetails.md deleted file mode 100644 index 5712b86..0000000 --- a/docs/ChargesDetails.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.ChargesDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**service_charges** | **decimal** | | [optional] -**service_tax** | **decimal** | | [optional] -**amount** | **decimal** | | [optional] -**billed_to** | **string** | | [optional] -**is_postpaid** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateCustomerRequest.md b/docs/CreateCustomerRequest.md deleted file mode 100644 index 1f075f0..0000000 --- a/docs/CreateCustomerRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.CreateCustomerRequest -Request body to create a customer at cashfree - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_phone** | **string** | Customer Phone Number | -**customer_email** | **string** | Customer Email | [optional] -**customer_name** | **string** | Customer Name | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateLinkRequest.md b/docs/CreateLinkRequest.md deleted file mode 100644 index ea81cba..0000000 --- a/docs/CreateLinkRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# cashfree_pg.Model.CreateLinkRequest -Request paramenters for link creation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**link_id** | **string** | Unique Identifier (provided by merchant) for the Link. Alphanumeric and only - and _ allowed (50 character limit). Use this for other link-related APIs. | -**link_amount** | **double** | Amount to be collected using this link. Provide upto two decimals for paise. | -**link_currency** | **string** | Currency for the payment link. Default is INR. Contact care@cashfree.com to enable new currencies. | -**link_purpose** | **string** | A brief description for which payment must be collected. This is shown to the customer. | -**customer_details** | [**LinkCustomerDetailsEntity**](LinkCustomerDetailsEntity.md) | | -**link_partial_payments** | **bool** | If \"true\", customer can make partial payments for the link. | [optional] -**link_minimum_partial_amount** | **double** | 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. | [optional] -**link_expiry_time** | **string** | 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. | [optional] -**link_notify** | [**LinkNotifyEntity**](LinkNotifyEntity.md) | | [optional] -**link_auto_reminders** | **bool** | If \"true\", reminders will be sent to customers for collecting payments. | [optional] -**link_notes** | **Dictionary<string, string>** | Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs | [optional] -**link_meta** | [**LinkMetaResponseEntity**](LinkMetaResponseEntity.md) | | [optional] -**order_splits** | [**List<VendorSplit>**](VendorSplit.md) | If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateOfferRequest.md b/docs/CreateOfferRequest.md deleted file mode 100644 index ae2bfec..0000000 --- a/docs/CreateOfferRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.CreateOfferRequest -create offer backend request object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**offer_meta** | [**OfferMeta**](OfferMeta.md) | | -**offer_tnc** | [**OfferTnc**](OfferTnc.md) | | -**offer_details** | [**OfferDetails**](OfferDetails.md) | | -**offer_validations** | [**OfferValidations**](OfferValidations.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateOrderRequest.md b/docs/CreateOrderRequest.md deleted file mode 100644 index 87eac35..0000000 --- a/docs/CreateOrderRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# cashfree_pg.Model.CreateOrderRequest -Request body to create an order at cashfree - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order_id** | **string** | Order identifier present in your system. Alphanumeric, '_' and '-' only | [optional] -**order_amount** | **double** | Bill amount for the order. Provide upto two decimals. 10.15 means Rs 10 and 15 paisa | -**order_currency** | **string** | Currency for the order. INR if left empty. Contact care@cashfree.com to enable new currencies. | -**customer_details** | [**CustomerDetails**](CustomerDetails.md) | | -**terminal** | [**TerminalDetails**](TerminalDetails.md) | | [optional] -**order_meta** | [**OrderMeta**](OrderMeta.md) | | [optional] -**order_expiry_time** | **string** | 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 | [optional] -**order_note** | **string** | Order note for reference. | [optional] -**order_tags** | **Dictionary<string, string>** | Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added | [optional] -**order_splits** | [**List<VendorSplit>**](VendorSplit.md) | If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateOrderRequestOrderMeta.md b/docs/CreateOrderRequestOrderMeta.md deleted file mode 100644 index ce0d9ec..0000000 --- a/docs/CreateOrderRequestOrderMeta.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.CreateOrderRequestOrderMeta - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**return_url** | **string** | The URL to which user will be redirected to after the payment on bank OTP page. Maximum length: 250. The return_url must contain placeholder {order_id}. When redirecting the customer back to the return url from the bank’s OTP page, Cashfree will replace this placeholder with the actual value for that order. | [optional] -**notify_url** | **string** | Notification URL for server-server communication. Useful when user's connection drops while re-directing. NotifyUrl should be an https URL. Maximum length: 250. | [optional] -**payment_methods** | **Object** | 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 | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateOrderRequestTerminal.md b/docs/CreateOrderRequestTerminal.md deleted file mode 100644 index e8da4d0..0000000 --- a/docs/CreateOrderRequestTerminal.md +++ /dev/null @@ -1,19 +0,0 @@ -# cashfree_pg.Model.CreateOrderRequestTerminal - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**added_on** | **string** | date time at which terminal is added | [optional] -**cf_terminal_id** | **int** | cashfree terminal id | [optional] -**last_updated_on** | **string** | last instant when this terminal was updated | [optional] -**terminal_address** | **string** | location of terminal | [optional] -**terminal_id** | **string** | terminal id for merchant reference | -**terminal_name** | **string** | name of terminal/agent/storefront | [optional] -**terminal_note** | **string** | note given by merchant while creating the terminal | [optional] -**terminal_phone_no** | **string** | mobile num of the terminal/agent/storefront | -**terminal_status** | **string** | status of terminal active/inactive | [optional] -**terminal_type** | **string** | To identify the type of terminal product in use, in this case it is SPOS. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateTerminalRequest.md b/docs/CreateTerminalRequest.md deleted file mode 100644 index c3dac06..0000000 --- a/docs/CreateTerminalRequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# cashfree_pg.Model.CreateTerminalRequest -Request body to create a terminal - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminal_id** | **string** | merchant’s internal terminal id | -**terminal_phone_no** | **string** | phone number assigned to the terminal | -**terminal_name** | **string** | terminal name to be assigned by merchants | -**terminal_address** | **string** | address of the terminal. required for STOREFRONT | [optional] -**terminal_email** | **string** | terminal email ID of the AGENT/STOREFRONT assigned by merchants. | -**terminal_note** | **string** | additional note for terminal | [optional] -**terminal_type** | **string** | mention the terminal type. possible values - AGENT, STOREFRONT. | -**terminal_meta** | [**CreateTerminalRequestTerminalMeta**](CreateTerminalRequestTerminalMeta.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateTerminalRequestTerminalMeta.md b/docs/CreateTerminalRequestTerminalMeta.md deleted file mode 100644 index c649f51..0000000 --- a/docs/CreateTerminalRequestTerminalMeta.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.CreateTerminalRequestTerminalMeta -terminal metadata. required field for storefront. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminal_operator** | **string** | name of the STOREFRONT operator. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateTerminalTransactionRequest.md b/docs/CreateTerminalTransactionRequest.md deleted file mode 100644 index 9aa4b55..0000000 --- a/docs/CreateTerminalTransactionRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.CreateTerminalTransactionRequest -Request body to create a terminal transaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_order_id** | **string** | cashfree order ID that was returned while creating an order. | -**cf_terminal_id** | **string** | cashfree terminal id. this is a required parameter when you do not provide the terminal phone number. | [optional] -**payment_method** | **string** | mention the payment method used for the transaction. possible values - QR_CODE, LINK. | -**terminal_phone_no** | **string** | agent mobile number assigned to the terminal. this is a required parameter when you do not provide the cf_terminal_id. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateVendorRequest.md b/docs/CreateVendorRequest.md deleted file mode 100644 index 5d8a5ae..0000000 --- a/docs/CreateVendorRequest.md +++ /dev/null @@ -1,21 +0,0 @@ -# cashfree_pg.Model.CreateVendorRequest -Create Vendor Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vendor_id** | **string** | Specify the unique Vendor ID to identify the beneficiary. Alphanumeric and underscore (_) allowed. | -**status** | **string** | Specify the status of vendor that should be updated. Possible values: ACTIVE,BLOCKED, DELETED | -**name** | **string** | Specify the name of the vendor to be updated. Name should not have any special character except . / - & | -**email** | **string** | Specify the vendor email ID that should be updated. String in email ID format (Ex:johndoe_1@cashfree.com) should contain @ and dot (.) | -**phone** | **string** | Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits, 8 - 12 characters after excluding +91). | -**verify_account** | **bool** | Specify if the vendor bank account details should be verified. Possible values: true or false | [optional] -**dashboard_access** | **bool** | Update if the vendor will have dashboard access or not. Possible values are: true or false | [optional] -**schedule_option** | **decimal** | 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. | [optional] -**bank** | [**List<BankDetails>**](BankDetails.md) | Specify the vendor bank account details to be updated. | [optional] -**upi** | [**List<UpiDetails>**](UpiDetails.md) | 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. | [optional] -**kyc_details** | [**List<KycDetails>**](KycDetails.md) | Specify the kyc details that should be updated. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateVendorResponse.md b/docs/CreateVendorResponse.md deleted file mode 100644 index afbde08..0000000 --- a/docs/CreateVendorResponse.md +++ /dev/null @@ -1,21 +0,0 @@ -# cashfree_pg.Model.CreateVendorResponse -Create Vendor Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **string** | | [optional] -**status** | **string** | | [optional] -**bank** | [**List<BankDetails>**](BankDetails.md) | | [optional] -**upi** | **string** | | [optional] -**phone** | **decimal** | | [optional] -**name** | **string** | | [optional] -**vendor_id** | **string** | | [optional] -**schedule_option** | [**List<ScheduleOption>**](ScheduleOption.md) | | [optional] -**kyc_details** | [**List<KycDetails>**](KycDetails.md) | | [optional] -**dashboard_access** | **bool** | | [optional] -**bank_details** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CryptogramEntity.md b/docs/CryptogramEntity.md deleted file mode 100644 index cc0499f..0000000 --- a/docs/CryptogramEntity.md +++ /dev/null @@ -1,17 +0,0 @@ -# cashfree_pg.Model.CryptogramEntity -Crytogram Card object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**instrument_id** | **string** | instrument_id of saved instrument | [optional] -**token_requestor_id** | **string** | TRID issued by card networks | [optional] -**card_number** | **string** | token pan number | [optional] -**card_expiry_mm** | **string** | token pan expiry month | [optional] -**card_expiry_yy** | **string** | token pan expiry year | [optional] -**cryptogram** | **string** | cryptogram | [optional] -**card_display** | **string** | last 4 digits of original card number | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CustomerDetails.md b/docs/CustomerDetails.md deleted file mode 100644 index f637888..0000000 --- a/docs/CustomerDetails.md +++ /dev/null @@ -1,18 +0,0 @@ -# cashfree_pg.Model.CustomerDetails -The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_id** | **string** | A unique identifier for the customer. Use alphanumeric values only. | -**customer_email** | **string** | Customer email address. | [optional] -**customer_phone** | **string** | Customer phone number. | -**customer_name** | **string** | Name of the customer. | [optional] -**customer_bank_account_number** | **string** | Customer bank account. Required if you want to do a bank account check (TPV) | [optional] -**customer_bank_ifsc** | **string** | Customer bank IFSC. Required if you want to do a bank account check (TPV) | [optional] -**customer_bank_code** | **decimal** | Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV) | [optional] -**customer_uid** | **string** | Customer identifier at Cashfree. You will get this when you create/get customer | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CustomerDetailsCardlessEMI.md b/docs/CustomerDetailsCardlessEMI.md deleted file mode 100644 index a4ead16..0000000 --- a/docs/CustomerDetailsCardlessEMI.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.CustomerDetailsCardlessEMI -Details of the customer for whom eligibility is being checked. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_phone** | **string** | Phone Number of the customer | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CustomerEntity.md b/docs/CustomerEntity.md deleted file mode 100644 index d41c64a..0000000 --- a/docs/CustomerEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.CustomerEntity -The complete customer entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_uid** | **string** | unique id generated by cashfree for your customer | [optional] -**customer_phone** | **string** | Customer Phone Number | [optional] -**customer_email** | **string** | Customer Email | [optional] -**customer_name** | **string** | Customer Name | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CustomersApi.md b/docs/CustomersApi.md deleted file mode 100644 index dcb505a..0000000 --- a/docs/CustomersApi.md +++ /dev/null @@ -1,97 +0,0 @@ -# cashfree_pg.Api.CustomersApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGCreateCustomer**](CustomersApi.md#pgcreatecustomer) | **POST** /customers | Create Customer at Cashfree | - - -# **PGCreateCustomer** -> CustomerEntity PGCreateCustomer (string xApiVersion, CreateCustomerRequest createCustomerRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Create Customer at Cashfree - -Create Customer at Cashfree - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCreateCustomerExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var createCustomerRequest = new CreateCustomerRequest(); // CreateCustomerRequest | Request to create a new customer at Cashfree - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Create Customer at Cashfree - CustomerEntity result = cashfree.PGCreateCustomer(xApiVersion, createCustomerRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling CustomersApi.PGCreateCustomer: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **createCustomerRequest** | [**CreateCustomerRequest**](CreateCustomerRequest.md) | Request to create a new customer at Cashfree | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**CustomerEntity**](CustomerEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/DiscountDetails.md b/docs/DiscountDetails.md deleted file mode 100644 index 01f95dc..0000000 --- a/docs/DiscountDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.DiscountDetails -detils of the discount object of offer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**discount_type** | **string** | Type of discount | -**discount_value** | **decimal** | Value of Discount. | -**max_discount_amount** | **decimal** | Maximum Value of Discount allowed. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EMIOffer.md b/docs/EMIOffer.md deleted file mode 100644 index a4ff307..0000000 --- a/docs/EMIOffer.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.EMIOffer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **string** | Type of emi offer. Possible values are `credit_card_emi`, `debit_card_emi`, `cardless_emi` | -**issuer** | **string** | Bank Name | -**tenures** | **List<int>** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EMIPlansArray.md b/docs/EMIPlansArray.md deleted file mode 100644 index 2c650ce..0000000 --- a/docs/EMIPlansArray.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.EMIPlansArray -Single EMI object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tenure** | **int** | | [optional] -**interest_rate** | **decimal** | | [optional] -**currency** | **string** | | [optional] -**emi** | **int** | | [optional] -**total_interest** | **int** | | [optional] -**total_amount** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ESOrderReconRequest.md b/docs/ESOrderReconRequest.md deleted file mode 100644 index 110595a..0000000 --- a/docs/ESOrderReconRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.ESOrderReconRequest -ES Order Recon Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filters** | [**ESOrderReconRequestFilters**](ESOrderReconRequestFilters.md) | | -**pagination** | [**ESOrderReconRequestPagination**](ESOrderReconRequestPagination.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ESOrderReconRequestFilters.md b/docs/ESOrderReconRequestFilters.md deleted file mode 100644 index 7158bb6..0000000 --- a/docs/ESOrderReconRequestFilters.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.ESOrderReconRequestFilters -Provide the filter object details. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_date** | **string** | Specify the start data from which you want to get the recon data. | [optional] -**end_date** | **string** | Specify the end data till which you want to get the recon data. | [optional] -**order_ids** | **List<string>** | Please provide list of order ids for which you want to get the recon data. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ESOrderReconRequestPagination.md b/docs/ESOrderReconRequestPagination.md deleted file mode 100644 index 371ab79..0000000 --- a/docs/ESOrderReconRequestPagination.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.ESOrderReconRequestPagination -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 - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cursor** | **string** | | [optional] -**limit** | **int** | Set the minimum/maximum limit for number of filtered data. Min value - 10, Max value - 100. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ESOrderReconResponse.md b/docs/ESOrderReconResponse.md deleted file mode 100644 index ae9f2f6..0000000 --- a/docs/ESOrderReconResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.ESOrderReconResponse -ES Order Recon Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cursor** | **string** | | [optional] -**data** | [**List<ESOrderReconResponseDataInner>**](ESOrderReconResponseDataInner.md) | | [optional] -**limit** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ESOrderReconResponseDataInner.md b/docs/ESOrderReconResponseDataInner.md deleted file mode 100644 index 2ec0066..0000000 --- a/docs/ESOrderReconResponseDataInner.md +++ /dev/null @@ -1,35 +0,0 @@ -# cashfree_pg.Model.ESOrderReconResponseDataInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount** | **decimal** | | [optional] -**settlement_eligibility_time** | **string** | | [optional] -**merchant_order_id** | **string** | | [optional] -**tx_time** | **string** | | [optional] -**settled** | **string** | | [optional] -**entity_id** | **string** | | [optional] -**merchant_settlement_utr** | **string** | | [optional] -**currency** | **string** | | [optional] -**sale_type** | **string** | | [optional] -**customer_name** | **string** | | [optional] -**customer_email** | **string** | | [optional] -**customer_phone** | **string** | | [optional] -**merchant_vendor_commission** | **string** | | [optional] -**split_service_charge** | **string** | | [optional] -**split_service_tax** | **string** | | [optional] -**pg_service_tax** | **string** | | [optional] -**pg_service_charge** | **string** | | [optional] -**pg_charge_postpaid** | **string** | | [optional] -**merchant_settlement_id** | **string** | | [optional] -**added_on** | **string** | | [optional] -**tags** | **string** | | [optional] -**entity_type** | **string** | | [optional] -**settlement_initiated_on** | **string** | | [optional] -**settlement_time** | **string** | | [optional] -**order_splits** | [**List<ESOrderReconResponseDataInnerOrderSplitsInner>**](ESOrderReconResponseDataInnerOrderSplitsInner.md) | | [optional] -**eligible_split_balance** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ESOrderReconResponseDataInnerOrderSplitsInner.md b/docs/ESOrderReconResponseDataInnerOrderSplitsInner.md deleted file mode 100644 index 690bbc2..0000000 --- a/docs/ESOrderReconResponseDataInnerOrderSplitsInner.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.ESOrderReconResponseDataInnerOrderSplitsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**split** | [**List<ESOrderReconResponseDataInnerOrderSplitsInnerSplitInner>**](ESOrderReconResponseDataInnerOrderSplitsInnerSplitInner.md) | | [optional] -**created_at** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ESOrderReconResponseDataInnerOrderSplitsInnerSplitInner.md b/docs/ESOrderReconResponseDataInnerOrderSplitsInnerSplitInner.md deleted file mode 100644 index c7f4fcf..0000000 --- a/docs/ESOrderReconResponseDataInnerOrderSplitsInnerSplitInner.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.ESOrderReconResponseDataInnerOrderSplitsInnerSplitInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_vendor_id** | **string** | | [optional] -**percentage** | **decimal** | | [optional] -**tags** | **Object** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EasySplitApi.md b/docs/EasySplitApi.md deleted file mode 100644 index c04a619..0000000 --- a/docs/EasySplitApi.md +++ /dev/null @@ -1,1034 +0,0 @@ -# cashfree_pg.Api.EasySplitApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGESCreateOnDemandTransfer**](EasySplitApi.md#pgescreateondemandtransfer) | **POST** /easy-split/vendors/{vendor_id}/transfer | Create On Demand Transfer | -| [**PGESCreateVendors**](EasySplitApi.md#pgescreatevendors) | **POST** /easy-split/vendors | Create vendor | -| [**PGESDownloadVendorsDocs**](EasySplitApi.md#pgesdownloadvendorsdocs) | **GET** /easy-split/vendor-docs/{vendor_id}/download/{doc_type} | Download Vendor Documents | -| [**PGESFetchVendors**](EasySplitApi.md#pgesfetchvendors) | **GET** /easy-split/vendors/{vendor_id} | Get Vendor All Details | -| [**PGESGetVendorBalance**](EasySplitApi.md#pgesgetvendorbalance) | **GET** /easy-split/vendors/{vendor_id}/balances | Get On Demand Balance | -| [**PGESGetVendorBalanceTransferCharges**](EasySplitApi.md#pgesgetvendorbalancetransfercharges) | **GET** /easy-split/amount/{amount}/charges | Get Vendor Balance Transfer Charges | -| [**PGESGetVendorsDocs**](EasySplitApi.md#pgesgetvendorsdocs) | **GET** /easy-split/vendor-docs/{vendor_id} | Get Vendor All Documents Status | -| [**PGESOrderRecon**](EasySplitApi.md#pgesorderrecon) | **POST** /split/order/vendor/recon | Get Split and Settlement Details by OrderID v2.0 | -| [**PGESUpdateVendors**](EasySplitApi.md#pgesupdatevendors) | **PATCH** /easy-split/vendors/{vendor_id} | Update vendor Details | -| [**PGESUploadVendorsDocs**](EasySplitApi.md#pgesuploadvendorsdocs) | **POST** /easy-split/vendor-docs/{vendor_id} | Upload Vendor Docs | -| [**PGOrderSplitAfterPayment**](EasySplitApi.md#pgordersplitafterpayment) | **POST** /easy-split/orders/{order_id}/split | Split After Payment | -| [**PGOrderStaticSplit**](EasySplitApi.md#pgorderstaticsplit) | **POST** /easy-split/static-split | Create Static Split Configuration | - - -# **PGESCreateOnDemandTransfer** -> AdjustVendorBalanceResponse PGESCreateOnDemandTransfer (string xApiVersion, string vendorId, string? xRequestId = null, Guid? xIdempotencyKey = null, AdjustVendorBalanceRequest? adjustVendorBalanceRequest = null) - -Create On Demand Transfer - -The Create On Demand Transfer API will create a new on-demand request either from to the merchant or from to the vendor. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESCreateOnDemandTransferExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var vendorId = your-vendor-id; // string | The id which uniquely identifies your vendor. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var adjustVendorBalanceRequest = new AdjustVendorBalanceRequest?(); // AdjustVendorBalanceRequest? | Adjust Vendor Balance Request Body. (optional) - - try - { - // Create On Demand Transfer - AdjustVendorBalanceResponse result = cashfree.PGESCreateOnDemandTransfer(xApiVersion, vendorId, xRequestId, xIdempotencyKey, adjustVendorBalanceRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESCreateOnDemandTransfer: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **vendorId** | **string** | The id which uniquely identifies your vendor. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **adjustVendorBalanceRequest** | [**AdjustVendorBalanceRequest?**](AdjustVendorBalanceRequest?.md) | Adjust Vendor Balance Request Body. | [optional] | - -### Return type - -[**AdjustVendorBalanceResponse**](AdjustVendorBalanceResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Adjust Vendor Balance Success Response. | - | -| **400** | Adjust Vendor Balance Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESCreateVendors** -> CreateVendorResponse PGESCreateVendors (string xApiVersion, string? xRequestId = null, Guid? xIdempotencyKey = null, CreateVendorRequest? createVendorRequest = null) - -Create vendor - -Use this API to create a new vendor to your EasySplit account along with the KYC details. Provide KYC details such as account_type, business_type, gst, cin, pan, passport number and so on. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESCreateVendorsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var createVendorRequest = new CreateVendorRequest?(); // CreateVendorRequest? | Create Vendor Request Body. (optional) - - try - { - // Create vendor - CreateVendorResponse result = cashfree.PGESCreateVendors(xApiVersion, xRequestId, xIdempotencyKey, createVendorRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESCreateVendors: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **createVendorRequest** | [**CreateVendorRequest?**](CreateVendorRequest?.md) | Create Vendor Request Body. | [optional] | - -### Return type - -[**CreateVendorResponse**](CreateVendorResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Create Vendor Success Response. | - | -| **400** | Create Vendor Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESDownloadVendorsDocs** -> VendorDocumentDownloadResponse PGESDownloadVendorsDocs (string xApiVersion, string docType, string vendorId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Download Vendor Documents - -Use this API to download the uploaded KYC documents of that particular vendor. Provide the document type. Click the link from the sample request to download the KYC document. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESDownloadVendorsDocsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var docType = "docType_example"; // string | Mention the document type that has to be downloaded. Only an uploaded document can be downloaded. - var vendorId = your-vendor-id; // string | The id which uniquely identifies your vendor. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Download Vendor Documents - VendorDocumentDownloadResponse result = cashfree.PGESDownloadVendorsDocs(xApiVersion, docType, vendorId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESDownloadVendorsDocs: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **docType** | **string** | Mention the document type that has to be downloaded. Only an uploaded document can be downloaded. | | -| **vendorId** | **string** | The id which uniquely identifies your vendor. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**VendorDocumentDownloadResponse**](VendorDocumentDownloadResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Download Vendor Docs Success Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESFetchVendors** -> VendorEntity PGESFetchVendors (string xApiVersion, string vendorId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Vendor All Details - -Use this API to get the details of a specific vendor associated with your Easy Split account. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESFetchVendorsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var vendorId = your-vendor-id; // string | The id which uniquely identifies your vendor. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Vendor All Details - VendorEntity result = cashfree.PGESFetchVendors(xApiVersion, vendorId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESFetchVendors: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **vendorId** | **string** | The id which uniquely identifies your vendor. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**VendorEntity**](VendorEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Get Vendor Success Response. | - | -| **400** | Get Vendor Docs Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESGetVendorBalance** -> VendorBalance PGESGetVendorBalance (string xApiVersion, string vendorId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get On Demand Balance - -This API fetches the available amount with the merchant, vendor, and the unsettled amount for the merchant as well as the vendor. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESGetVendorBalanceExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var vendorId = your-vendor-id; // string | The id which uniquely identifies your vendor. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get On Demand Balance - VendorBalance result = cashfree.PGESGetVendorBalance(xApiVersion, vendorId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESGetVendorBalance: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **vendorId** | **string** | The id which uniquely identifies your vendor. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**VendorBalance**](VendorBalance.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Get Vendor Balance Success Response. | - | -| **400** | Get Vendor Docs Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESGetVendorBalanceTransferCharges** -> VendorBalanceTransferCharges PGESGetVendorBalanceTransferCharges (string xApiVersion, decimal amount, string rateType, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Vendor Balance Transfer Charges - -This API returns the applicable service charge and service tax for a vendor balance transfer, based on the provided amount and rate type. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESGetVendorBalanceTransferChargesExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var amount = 1000; // decimal | Specify the amount for which you want to view the service charges and service taxes in the response. - var rateType = VENDOR_ON_DEMAND; // string | Mention the type of rate for which you want to check the charges. Possible value: VENDOR_ON_DEMAND - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Vendor Balance Transfer Charges - VendorBalanceTransferCharges result = cashfree.PGESGetVendorBalanceTransferCharges(xApiVersion, amount, rateType, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESGetVendorBalanceTransferCharges: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **amount** | **decimal** | Specify the amount for which you want to view the service charges and service taxes in the response. | | -| **rateType** | **string** | Mention the type of rate for which you want to check the charges. Possible value: VENDOR_ON_DEMAND | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**VendorBalanceTransferCharges**](VendorBalanceTransferCharges.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Get Vendor Balance Transfer Charges Response. | - | -| **400** | Get Vendor Balance Transfer Charges Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESGetVendorsDocs** -> VendorDocumentsResponse PGESGetVendorsDocs (string xApiVersion, string vendorId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Vendor All Documents Status - -Use this API to fetch the details of all the KYC details of a particular vendor. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESGetVendorsDocsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var vendorId = your-vendor-id; // string | The id which uniquely identifies your vendor. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Vendor All Documents Status - VendorDocumentsResponse result = cashfree.PGESGetVendorsDocs(xApiVersion, vendorId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESGetVendorsDocs: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **vendorId** | **string** | The id which uniquely identifies your vendor. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**VendorDocumentsResponse**](VendorDocumentsResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Get Vendor Docs Success Response. | - | -| **400** | Get Vendor Docs Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESOrderRecon** -> ESOrderReconResponse PGESOrderRecon (string xApiVersion, string? xRequestId = null, Guid? xIdempotencyKey = null, ESOrderReconRequest? eSOrderReconRequest = null) - -Get Split and Settlement Details by OrderID v2.0 - -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. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESOrderReconExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var eSOrderReconRequest = new ESOrderReconRequest?(); // ESOrderReconRequest? | Get Split and Settlement Details by OrderID v2.0 (optional) - - try - { - // Get Split and Settlement Details by OrderID v2.0 - ESOrderReconResponse result = cashfree.PGESOrderRecon(xApiVersion, xRequestId, xIdempotencyKey, eSOrderReconRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESOrderRecon: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **eSOrderReconRequest** | [**ESOrderReconRequest?**](ESOrderReconRequest?.md) | Get Split and Settlement Details by OrderID v2.0 | [optional] | - -### Return type - -[**ESOrderReconResponse**](ESOrderReconResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | ES Order Recon Success Response. | - | -| **400** | ES Order Recon Failure Response. | - | -| **404** | ES Order Recon Failure Response. | - | -| **409** | ES Order Recon Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESUpdateVendors** -> UpdateVendorResponse PGESUpdateVendors (string xApiVersion, string vendorId, string? xRequestId = null, Guid? xIdempotencyKey = null, UpdateVendorRequest? updateVendorRequest = null) - -Update vendor Details - -Use this API to edit the existing vendor details added to your EasySplit account. You can edit vendor details such as name, email, phone number, upi details, and any of the KYC details. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESUpdateVendorsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var vendorId = your-vendor-id; // string | The id which uniquely identifies your vendor. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var updateVendorRequest = new UpdateVendorRequest?(); // UpdateVendorRequest? | Create Vendor Request Body. (optional) - - try - { - // Update vendor Details - UpdateVendorResponse result = cashfree.PGESUpdateVendors(xApiVersion, vendorId, xRequestId, xIdempotencyKey, updateVendorRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESUpdateVendors: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **vendorId** | **string** | The id which uniquely identifies your vendor. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **updateVendorRequest** | [**UpdateVendorRequest?**](UpdateVendorRequest?.md) | Create Vendor Request Body. | [optional] | - -### Return type - -[**UpdateVendorResponse**](UpdateVendorResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Update Vendor Success Response. | - | -| **400** | Update Vendor Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGESUploadVendorsDocs** -> UploadVendorDocumentsResponse PGESUploadVendorsDocs (string xApiVersion, string vendorId, string? xRequestId = null, Guid? xIdempotencyKey = null, string? docType = null, string? docValue = null, System.IO.Stream? file = null) - -Upload Vendor Docs - -Use this API to upload KYC documents of a specific vendor. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGESUploadVendorsDocsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var vendorId = your-vendor-id; // string | The id which uniquely identifies your vendor. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var docType = "docType_example"; // string? | Mention the type of the document you are uploading. Possible values: UIDAI_FRONT, UIDAI_BACK, UIDAI_NUMBER, DL, DL_NUMBER, PASSPORT_FRONT, PASSPORT_BACK, PASSPORT_NUMBER, VOTER_ID, VOTER_ID_NUMBER, PAN, PAN_NUMBER, GST, GSTIN_NUMBER, CIN, CIN_NUMBER, NBFC_CERTIFICATE. If the doc type ends with a number you should add the doc value else upload the doc file. (optional) - var docValue = "docValue_example"; // string? | Enter the display name of the uploaded file. (optional) - var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // System.IO.Stream? | 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. (optional) - - try - { - // Upload Vendor Docs - UploadVendorDocumentsResponse result = cashfree.PGESUploadVendorsDocs(xApiVersion, vendorId, xRequestId, xIdempotencyKey, docType, docValue, file); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGESUploadVendorsDocs: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **vendorId** | **string** | The id which uniquely identifies your vendor. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **docType** | **string?** | Mention the type of the document you are uploading. Possible values: UIDAI_FRONT, UIDAI_BACK, UIDAI_NUMBER, DL, DL_NUMBER, PASSPORT_FRONT, PASSPORT_BACK, PASSPORT_NUMBER, VOTER_ID, VOTER_ID_NUMBER, PAN, PAN_NUMBER, GST, GSTIN_NUMBER, CIN, CIN_NUMBER, NBFC_CERTIFICATE. If the doc type ends with a number you should add the doc value else upload the doc file. | [optional] | -| **docValue** | **string?** | Enter the display name of the uploaded file. | [optional] | -| **file** | **System.IO.Stream?****System.IO.Stream?** | 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. | [optional] | - -### Return type - -[**UploadVendorDocumentsResponse**](UploadVendorDocumentsResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Upload Vendor Docs Success Response. | - | -| **400** | Upload Vendor Docs Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGOrderSplitAfterPayment** -> SplitAfterPaymentResponse PGOrderSplitAfterPayment (string xApiVersion, string orderId, string? xRequestId = null, Guid? xIdempotencyKey = null, SplitAfterPaymentRequest? splitAfterPaymentRequest = null) - -Split After Payment - -Split After Payment API splits the payments to vendors after successful payment from the customers. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderSplitAfterPaymentExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var splitAfterPaymentRequest = new SplitAfterPaymentRequest?(); // SplitAfterPaymentRequest? | Request Body to Create Split for an order. (optional) - - try - { - // Split After Payment - SplitAfterPaymentResponse result = cashfree.PGOrderSplitAfterPayment(xApiVersion, orderId, xRequestId, xIdempotencyKey, splitAfterPaymentRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGOrderSplitAfterPayment: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **splitAfterPaymentRequest** | [**SplitAfterPaymentRequest?**](SplitAfterPaymentRequest?.md) | Request Body to Create Split for an order. | [optional] | - -### Return type - -[**SplitAfterPaymentResponse**](SplitAfterPaymentResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Split After Payment Success Response. | - | -| **400** | Split After Payment Failure Response. | - | -| **404** | Split After Payment Failure Response. | - | -| **409** | Split After Payment Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGOrderStaticSplit** -> StaticSplitResponse PGOrderStaticSplit (string xApiVersion, string? xRequestId = null, Guid? xIdempotencyKey = null, StaticSplitRequest? staticSplitRequest = null) - -Create Static Split Configuration - -This API will create a static split scheme wherein you can define the split type and the vendor-wise split percentage. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderStaticSplitExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var staticSplitRequest = new StaticSplitRequest?(); // StaticSplitRequest? | Static Split (optional) - - try - { - // Create Static Split Configuration - StaticSplitResponse result = cashfree.PGOrderStaticSplit(xApiVersion, xRequestId, xIdempotencyKey, staticSplitRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EasySplitApi.PGOrderStaticSplit: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **staticSplitRequest** | [**StaticSplitRequest?**](StaticSplitRequest?.md) | Static Split | [optional] | - -### Return type - -[**StaticSplitResponse**](StaticSplitResponse.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Static Split Success Response. | - | -| **400** | Static Split Failure Response. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/EligibilityApi.md b/docs/EligibilityApi.md deleted file mode 100644 index d868831..0000000 --- a/docs/EligibilityApi.md +++ /dev/null @@ -1,370 +0,0 @@ -# cashfree_pg.Api.EligibilityApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGEligibilityFetchCardlessEMI**](EligibilityApi.md#pgeligibilityfetchcardlessemi) | **POST** /eligibility/cardlessemi | Get Eligible Cardless EMI Payment Methods for a customer on an order | -| [**PGEligibilityFetchOffers**](EligibilityApi.md#pgeligibilityfetchoffers) | **POST** /eligibility/offers | Get Eligible Offers for an Order | -| [**PGEligibilityFetchPaylater**](EligibilityApi.md#pgeligibilityfetchpaylater) | **POST** /eligibility/paylater | Get Eligible Paylater for a customer on an order | -| [**PGEligibilityFetchPaymentMethods**](EligibilityApi.md#pgeligibilityfetchpaymentmethods) | **POST** /eligibility/payment_methods | Get eligible Payment Methods | - - -# **PGEligibilityFetchCardlessEMI** -> List<EligibilityCardlessEMIEntity> PGEligibilityFetchCardlessEMI (string xApiVersion, EligibilityFetchCardlessEMIRequest eligibilityFetchCardlessEMIRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Eligible Cardless EMI Payment Methods for a customer on an order - -Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their phone number. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGEligibilityFetchCardlessEMIExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var eligibilityFetchCardlessEMIRequest = new EligibilityFetchCardlessEMIRequest(); // EligibilityFetchCardlessEMIRequest | Request Body to get eligible cardless emi options for a customer and order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Eligible Cardless EMI Payment Methods for a customer on an order - List result = cashfree.PGEligibilityFetchCardlessEMI(xApiVersion, eligibilityFetchCardlessEMIRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchCardlessEMI: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **eligibilityFetchCardlessEMIRequest** | [**EligibilityFetchCardlessEMIRequest**](EligibilityFetchCardlessEMIRequest.md) | Request Body to get eligible cardless emi options for a customer and order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<EligibilityCardlessEMIEntity>**](EligibilityCardlessEMIEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGEligibilityFetchOffers** -> List<EligibilityOfferEntity> PGEligibilityFetchOffers (string xApiVersion, EligibilityFetchOffersRequest eligibilityFetchOffersRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Eligible Offers for an Order - -Use this API to get eligible offers for an order_id or order amount. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGEligibilityFetchOffersExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var eligibilityFetchOffersRequest = new EligibilityFetchOffersRequest(); // EligibilityFetchOffersRequest | Request Body to get eligible offers for a customer and order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Eligible Offers for an Order - List result = cashfree.PGEligibilityFetchOffers(xApiVersion, eligibilityFetchOffersRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchOffers: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **eligibilityFetchOffersRequest** | [**EligibilityFetchOffersRequest**](EligibilityFetchOffersRequest.md) | Request Body to get eligible offers for a customer and order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<EligibilityOfferEntity>**](EligibilityOfferEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGEligibilityFetchPaylater** -> List<EligibilityPaylaterEntity> PGEligibilityFetchPaylater (string xApiVersion, EligibilityFetchPaylaterRequest eligibilityFetchPaylaterRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Eligible Paylater for a customer on an order - -Use this API to get eligible Paylater Payment Methods for a customer on an order. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGEligibilityFetchPaylaterExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var eligibilityFetchPaylaterRequest = new EligibilityFetchPaylaterRequest(); // EligibilityFetchPaylaterRequest | Request Body to get eligible paylater options for a customer and order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Eligible Paylater for a customer on an order - List result = cashfree.PGEligibilityFetchPaylater(xApiVersion, eligibilityFetchPaylaterRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchPaylater: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **eligibilityFetchPaylaterRequest** | [**EligibilityFetchPaylaterRequest**](EligibilityFetchPaylaterRequest.md) | Request Body to get eligible paylater options for a customer and order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<EligibilityPaylaterEntity>**](EligibilityPaylaterEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGEligibilityFetchPaymentMethods** -> List<EligibilityPaymentMethodsEntity> PGEligibilityFetchPaymentMethods (string xApiVersion, EligibilityFetchPaymentMethodsRequest eligibilityFetchPaymentMethodsRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get eligible Payment Methods - -Use this API to get eligible Payment Methods - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGEligibilityFetchPaymentMethodsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var eligibilityFetchPaymentMethodsRequest = new EligibilityFetchPaymentMethodsRequest(); // EligibilityFetchPaymentMethodsRequest | Request Body to get eligible payment methods for an account and order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get eligible Payment Methods - List result = cashfree.PGEligibilityFetchPaymentMethods(xApiVersion, eligibilityFetchPaymentMethodsRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchPaymentMethods: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **eligibilityFetchPaymentMethodsRequest** | [**EligibilityFetchPaymentMethodsRequest**](EligibilityFetchPaymentMethodsRequest.md) | Request Body to get eligible payment methods for an account and order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<EligibilityPaymentMethodsEntity>**](EligibilityPaymentMethodsEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/EligibilityCardlessEMIEntity.md b/docs/EligibilityCardlessEMIEntity.md deleted file mode 100644 index e9bcaa3..0000000 --- a/docs/EligibilityCardlessEMIEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.EligibilityCardlessEMIEntity -Carless EMI eligible entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**eligibility** | **bool** | | [optional] -**entity_type** | **string** | | [optional] -**entity_value** | **string** | | [optional] -**entity_details** | [**CardlessEMIEntity**](CardlessEMIEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityFetchCardlessEMIRequest.md b/docs/EligibilityFetchCardlessEMIRequest.md deleted file mode 100644 index d951a45..0000000 --- a/docs/EligibilityFetchCardlessEMIRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.EligibilityFetchCardlessEMIRequest -eligibilty request for cardless - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**queries** | [**CardlessEMIQueries**](CardlessEMIQueries.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityFetchOffersRequest.md b/docs/EligibilityFetchOffersRequest.md deleted file mode 100644 index 9861e84..0000000 --- a/docs/EligibilityFetchOffersRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.EligibilityFetchOffersRequest -Eligiblty API request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**queries** | [**OfferQueries**](OfferQueries.md) | | -**filters** | [**OfferFilters**](OfferFilters.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityFetchPaylaterRequest.md b/docs/EligibilityFetchPaylaterRequest.md deleted file mode 100644 index 7a20a11..0000000 --- a/docs/EligibilityFetchPaylaterRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.EligibilityFetchPaylaterRequest -Request to get eligible paylater payment methods - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**queries** | [**CardlessEMIQueries**](CardlessEMIQueries.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityFetchPaymentMethodsRequest.md b/docs/EligibilityFetchPaymentMethodsRequest.md deleted file mode 100644 index 370b44c..0000000 --- a/docs/EligibilityFetchPaymentMethodsRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.EligibilityFetchPaymentMethodsRequest -eligibilty request to find eligible payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**queries** | [**PaymentMethodsQueries**](PaymentMethodsQueries.md) | | -**filters** | [**PaymentMethodsFilters**](PaymentMethodsFilters.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityOfferEntity.md b/docs/EligibilityOfferEntity.md deleted file mode 100644 index 707a99f..0000000 --- a/docs/EligibilityOfferEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.EligibilityOfferEntity -Eligible offer object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**eligibility** | **bool** | | [optional] -**entity_type** | **string** | | [optional] -**entity_value** | **string** | | [optional] -**entity_details** | [**OfferEntity**](OfferEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityPaylaterEntity.md b/docs/EligibilityPaylaterEntity.md deleted file mode 100644 index bad0877..0000000 --- a/docs/EligibilityPaylaterEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.EligibilityPaylaterEntity -Eligible paylater payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**eligibility** | **bool** | | [optional] -**entity_type** | **string** | | [optional] -**entity_value** | **string** | | [optional] -**entity_details** | [**PaylaterEntity**](PaylaterEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityPaymentMethodsEntity.md b/docs/EligibilityPaymentMethodsEntity.md deleted file mode 100644 index 63c5644..0000000 --- a/docs/EligibilityPaymentMethodsEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.EligibilityPaymentMethodsEntity -Eligible payment methods details - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**eligibility** | **bool** | | [optional] -**entity_type** | **string** | | [optional] -**entity_value** | **string** | | [optional] -**entity_details** | [**EligibilityPaymentMethodsEntityEntityDetails**](EligibilityPaymentMethodsEntityEntityDetails.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EligibilityPaymentMethodsEntityEntityDetails.md b/docs/EligibilityPaymentMethodsEntityEntityDetails.md deleted file mode 100644 index 63cd62a..0000000 --- a/docs/EligibilityPaymentMethodsEntityEntityDetails.md +++ /dev/null @@ -1,10 +0,0 @@ -# cashfree_pg.Model.EligibilityPaymentMethodsEntityEntityDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_method_details** | [**List<PaymentModeDetails>**](PaymentModeDetails.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ErrorDetailsInPaymentsEntity.md b/docs/ErrorDetailsInPaymentsEntity.md deleted file mode 100644 index f8f1a20..0000000 --- a/docs/ErrorDetailsInPaymentsEntity.md +++ /dev/null @@ -1,17 +0,0 @@ -# cashfree_pg.Model.ErrorDetailsInPaymentsEntity -The error details are present only for failed payments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error_code** | **string** | | [optional] -**error_description** | **string** | | [optional] -**error_reason** | **string** | | [optional] -**error_source** | **string** | | [optional] -**error_code_raw** | **string** | | [optional] -**error_description_raw** | **string** | | [optional] -**error_subcode_raw** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FetchReconRequest.md b/docs/FetchReconRequest.md deleted file mode 100644 index d77f38c..0000000 --- a/docs/FetchReconRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.FetchReconRequest -Recon object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pagination** | [**FetchReconRequestPagination**](FetchReconRequestPagination.md) | | -**filters** | [**FetchReconRequestFilters**](FetchReconRequestFilters.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FetchReconRequestFilters.md b/docs/FetchReconRequestFilters.md deleted file mode 100644 index d0e71f0..0000000 --- a/docs/FetchReconRequestFilters.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.FetchReconRequestFilters - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**start_date** | **string** | Specify the start date from when you want the settlement reconciliation details. | -**end_date** | **string** | Specify the end date till when you want the settlement reconciliation details. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FetchReconRequestPagination.md b/docs/FetchReconRequestPagination.md deleted file mode 100644 index 636346d..0000000 --- a/docs/FetchReconRequestPagination.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.FetchReconRequestPagination -To fetch the next set of settlements, pass the cursor received in the response to the next API call. To receive the data for the first time, pass the cursor as null. Limit would be number of settlements that you want to receive. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **int** | Number of settlements you want to fetch in the next iteration. Maximum limit is 1000, default value is 10. | -**cursor** | **string** | Specifies from where the next set of settlement details should be fetched. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FetchSettlementsRequest.md b/docs/FetchSettlementsRequest.md deleted file mode 100644 index 576f39b..0000000 --- a/docs/FetchSettlementsRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.FetchSettlementsRequest -Request to fetch settlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pagination** | [**FetchSettlementsRequestPagination**](FetchSettlementsRequestPagination.md) | | -**filters** | [**FetchSettlementsRequestFilters**](FetchSettlementsRequestFilters.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FetchSettlementsRequestFilters.md b/docs/FetchSettlementsRequestFilters.md deleted file mode 100644 index c68fba5..0000000 --- a/docs/FetchSettlementsRequestFilters.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.FetchSettlementsRequestFilters -Specify either the Settlement ID, Settlement UTR, or start date and end date to fetch the settlement details. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_settlement_ids** | **List<string>** | List of settlement IDs for which you want the settlement reconciliation details. | [optional] -**settlement_utrs** | **List<string>** | List of settlement UTRs for which you want the settlement reconciliation details. | [optional] -**start_date** | **string** | Specify the start date from when you want the settlement reconciliation details. | [optional] -**end_date** | **string** | Specify the end date till when you want the settlement reconciliation details. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FetchSettlementsRequestPagination.md b/docs/FetchSettlementsRequestPagination.md deleted file mode 100644 index 7019807..0000000 --- a/docs/FetchSettlementsRequestPagination.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.FetchSettlementsRequestPagination -To fetch the next set of settlements, pass the cursor received in the response to the next API call. To receive the data for the first time, pass the cursor as null. Limit would be number of settlements that you want to receive. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **int** | The number of settlements you want to fetch. Maximum limit is 1000, default value is 10. | -**cursor** | **string** | Specifies from where the next set of settlement details should be fetched. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FetchTerminalQRCodesEntity.md b/docs/FetchTerminalQRCodesEntity.md deleted file mode 100644 index fe24360..0000000 --- a/docs/FetchTerminalQRCodesEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.FetchTerminalQRCodesEntity -Fetch Static QR Codes using terminal ID or phone number - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bank** | **string** | Name of the bank that is linked to the Static QR. | [optional] -**qrCode** | **string** | Base-64 Encoded QR Code URL | [optional] -**qrCodeUrl** | **string** | URL of the qr Code. | [optional] -**status** | **string** | Status of the static QR. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IdempotencyError.md b/docs/IdempotencyError.md deleted file mode 100644 index 952b334..0000000 --- a/docs/IdempotencyError.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.IdempotencyError -Error when idempotency fails. Different request body with the same idempotent key - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | | [optional] -**type** | **string** | idempotency_error | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstrumentEntity.md b/docs/InstrumentEntity.md deleted file mode 100644 index ee57631..0000000 --- a/docs/InstrumentEntity.md +++ /dev/null @@ -1,19 +0,0 @@ -# cashfree_pg.Model.InstrumentEntity -Saved card instrument object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_id** | **string** | customer_id for which the instrument was saved | [optional] -**afa_reference** | **string** | cf_payment_id of the successful transaction done while saving instrument | [optional] -**instrument_id** | **string** | saved instrument id | [optional] -**instrument_type** | **string** | Type of the saved instrument | [optional] -**instrument_uid** | **string** | Unique id for the saved instrument | [optional] -**instrument_display** | **string** | masked card number displayed to the customer | [optional] -**instrument_status** | **string** | Status of the saved instrument. | [optional] -**created_at** | **string** | Timestamp at which instrument was saved. | [optional] -**instrument_meta** | [**SavedInstrumentMeta**](SavedInstrumentMeta.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstrumentWebhook.md b/docs/InstrumentWebhook.md deleted file mode 100644 index 0a20e73..0000000 --- a/docs/InstrumentWebhook.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.InstrumentWebhook -Instrument webhook object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**InstrumentWebhookData**](InstrumentWebhookData.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstrumentWebhookData.md b/docs/InstrumentWebhookData.md deleted file mode 100644 index 147814e..0000000 --- a/docs/InstrumentWebhookData.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.InstrumentWebhookData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**InstrumentWebhookDataEntity**](InstrumentWebhookDataEntity.md) | | [optional] -**event_time** | **string** | | [optional] -**type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InstrumentWebhookDataEntity.md b/docs/InstrumentWebhookDataEntity.md deleted file mode 100644 index e2121bf..0000000 --- a/docs/InstrumentWebhookDataEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.InstrumentWebhookDataEntity -data entity in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**instrument** | [**InstrumentEntity**](InstrumentEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/KycDetails.md b/docs/KycDetails.md deleted file mode 100644 index 22fbdf9..0000000 --- a/docs/KycDetails.md +++ /dev/null @@ -1,18 +0,0 @@ -# cashfree_pg.Model.KycDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_type** | **string** | | [optional] -**business_type** | **string** | | [optional] -**uidai** | **decimal** | | [optional] -**gst** | **string** | | [optional] -**cin** | **string** | | [optional] -**pan** | **string** | | [optional] -**passport_number** | **string** | | [optional] -**driving_license** | **string** | | [optional] -**voter_id** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LinkCustomerDetailsEntity.md b/docs/LinkCustomerDetailsEntity.md deleted file mode 100644 index f6fb2cf..0000000 --- a/docs/LinkCustomerDetailsEntity.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.LinkCustomerDetailsEntity -Payment link customer entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_phone** | **string** | Customer phone number | -**customer_email** | **string** | Customer email address | [optional] -**customer_name** | **string** | Customer name | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LinkEntity.md b/docs/LinkEntity.md deleted file mode 100644 index ff70e2f..0000000 --- a/docs/LinkEntity.md +++ /dev/null @@ -1,29 +0,0 @@ -# cashfree_pg.Model.LinkEntity -Payment link success creation response object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_link_id** | **string** | | [optional] -**link_id** | **string** | | [optional] -**link_status** | **string** | | [optional] -**link_currency** | **string** | | [optional] -**link_amount** | **decimal** | | [optional] -**link_amount_paid** | **decimal** | | [optional] -**link_partial_payments** | **bool** | | [optional] -**link_minimum_partial_amount** | **decimal** | | [optional] -**link_purpose** | **string** | | [optional] -**link_created_at** | **string** | | [optional] -**customer_details** | [**LinkCustomerDetailsEntity**](LinkCustomerDetailsEntity.md) | | [optional] -**link_meta** | [**LinkMetaResponseEntity**](LinkMetaResponseEntity.md) | | [optional] -**link_url** | **string** | | [optional] -**link_expiry_time** | **string** | | [optional] -**link_notes** | **Dictionary<string, string>** | Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs | [optional] -**link_auto_reminders** | **bool** | | [optional] -**link_notify** | [**LinkNotifyEntity**](LinkNotifyEntity.md) | | [optional] -**link_qrcode** | **string** | Base64 encoded string for payment link. You can scan with camera to open a link in the browser to complete the payment. | [optional] -**order_splits** | [**List<VendorSplit>**](VendorSplit.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LinkMetaEntity.md b/docs/LinkMetaEntity.md deleted file mode 100644 index f7f9790..0000000 --- a/docs/LinkMetaEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.LinkMetaEntity -Payment link meta information object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**notify_url** | **string** | Notification URL for server-server communication. It should be an https URL. | [optional] -**upi_intent** | **bool** | If \"true\", link will directly open UPI Intent flow on mobile, and normal link flow elsewhere | [optional] -**return_url** | **string** | The URL to which user will be redirected to after the payment is done on the link. Maximum length: 250. | [optional] -**payment_methods** | **string** | 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 | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LinkMetaResponseEntity.md b/docs/LinkMetaResponseEntity.md deleted file mode 100644 index e81b137..0000000 --- a/docs/LinkMetaResponseEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.LinkMetaResponseEntity -Payment link meta information object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**notify_url** | **string** | Notification URL for server-server communication. It should be an https URL. | [optional] -**upi_intent** | **bool** | If \"true\", link will directly open UPI Intent flow on mobile, and normal link flow elsewhere | [optional] -**return_url** | **string** | The URL to which user will be redirected to after the payment is done on the link. Maximum length: 250. | [optional] -**payment_methods** | **string** | 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 | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/LinkNotifyEntity.md b/docs/LinkNotifyEntity.md deleted file mode 100644 index aef697b..0000000 --- a/docs/LinkNotifyEntity.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.LinkNotifyEntity -Payment link Notify Object for SMS and Email - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**send_sms** | **bool** | If \"true\", Cashfree will send sms on customer_phone | [optional] -**send_email** | **bool** | If \"true\", Cashfree will send email on customer_email | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/NetBankingPaymentMethod.md b/docs/NetBankingPaymentMethod.md deleted file mode 100644 index 66019ab..0000000 --- a/docs/NetBankingPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.NetBankingPaymentMethod -Payment method for netbanking object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**netbanking** | [**Netbanking**](Netbanking.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Netbanking.md b/docs/Netbanking.md deleted file mode 100644 index df20cbd..0000000 --- a/docs/Netbanking.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.Netbanking -Netbanking payment method request body - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | The channel for netbanking will always be `link` | -**netbanking_bank_code** | **int** | Bank code | [optional] -**netbanking_bank_name** | **string** | String code for bank | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferAll.md b/docs/OfferAll.md deleted file mode 100644 index 961bd8a..0000000 --- a/docs/OfferAll.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferAll -returns all offers - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**all** | **Object** | All offers applicable | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferCard.md b/docs/OfferCard.md deleted file mode 100644 index 81c0940..0000000 --- a/docs/OfferCard.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferCard -Offers related to cards - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**CardOffer**](CardOffer.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferDetails.md b/docs/OfferDetails.md deleted file mode 100644 index 6bc5fe2..0000000 --- a/docs/OfferDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.OfferDetails -Offer details and type - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**offer_type** | **string** | Offer Type for the Offer. | -**discount_details** | [**DiscountDetails**](DiscountDetails.md) | | [optional] -**cashback_details** | [**CashbackDetails**](CashbackDetails.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferEMI.md b/docs/OfferEMI.md deleted file mode 100644 index d1d5c21..0000000 --- a/docs/OfferEMI.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferEMI -EMI offer object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emi** | [**EMIOffer**](EMIOffer.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferEntity.md b/docs/OfferEntity.md deleted file mode 100644 index 7eebdfb..0000000 --- a/docs/OfferEntity.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.OfferEntity -Offer entity object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**offer_id** | **string** | | [optional] -**offer_status** | **string** | | [optional] -**offer_meta** | [**OfferMeta**](OfferMeta.md) | | [optional] -**offer_tnc** | [**OfferTnc**](OfferTnc.md) | | [optional] -**offer_details** | [**OfferDetails**](OfferDetails.md) | | [optional] -**offer_validations** | [**OfferValidations**](OfferValidations.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferFilters.md b/docs/OfferFilters.md deleted file mode 100644 index 9174c9a..0000000 --- a/docs/OfferFilters.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferFilters -Filter for offers - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**offer_type** | [**List<OfferType>**](OfferType.md) | Array of offer_type to be filtered. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferMeta.md b/docs/OfferMeta.md deleted file mode 100644 index bb3f0f4..0000000 --- a/docs/OfferMeta.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.OfferMeta -Offer meta details object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**offer_title** | **string** | Title for the Offer. | -**offer_description** | **string** | Description for the Offer. | -**offer_code** | **string** | Unique identifier for the Offer. | -**offer_start_time** | **string** | Start Time for the Offer | -**offer_end_time** | **string** | Expiry Time for the Offer | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferNB.md b/docs/OfferNB.md deleted file mode 100644 index 42a7f5d..0000000 --- a/docs/OfferNB.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferNB -Offer object ofr NetBanking - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**netbanking** | [**OfferNBNetbanking**](OfferNBNetbanking.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferNBNetbanking.md b/docs/OfferNBNetbanking.md deleted file mode 100644 index ea76354..0000000 --- a/docs/OfferNBNetbanking.md +++ /dev/null @@ -1,10 +0,0 @@ -# cashfree_pg.Model.OfferNBNetbanking - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**bank_name** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferPaylater.md b/docs/OfferPaylater.md deleted file mode 100644 index 2ae7ff9..0000000 --- a/docs/OfferPaylater.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferPaylater -Offer object for paylater - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paylater** | [**PaylaterOffer**](PaylaterOffer.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferQueries.md b/docs/OfferQueries.md deleted file mode 100644 index 4b38e7a..0000000 --- a/docs/OfferQueries.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.OfferQueries -Offer Query Object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order_id** | **string** | OrderId of the order. Either of `order_id` or `order_amount` is mandatory. | [optional] -**amount** | **decimal** | Amount of the order. OrderId of the order. Either of `order_id` or `order_amount` is mandatory. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferTnc.md b/docs/OfferTnc.md deleted file mode 100644 index e62d77c..0000000 --- a/docs/OfferTnc.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.OfferTnc -Offer terms and condition object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**offer_tnc_type** | **string** | TnC Type for the Offer. It can be either `text` or `link` | -**offer_tnc_value** | **string** | TnC for the Offer. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferType.md b/docs/OfferType.md deleted file mode 100644 index 3f89594..0000000 --- a/docs/OfferType.md +++ /dev/null @@ -1,10 +0,0 @@ -# cashfree_pg.Model.OfferType -Offer Type Object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferUPI.md b/docs/OfferUPI.md deleted file mode 100644 index 6d3026c..0000000 --- a/docs/OfferUPI.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferUPI -Offer object for UPI - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**upi** | **Object** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferValidations.md b/docs/OfferValidations.md deleted file mode 100644 index fc79d89..0000000 --- a/docs/OfferValidations.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.OfferValidations -Offer validation object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**min_amount** | **decimal** | Minimum Amount for Offer to be Applicable | [optional] -**max_allowed** | **decimal** | Maximum Amount for Offer to be Applicable | -**payment_method** | [**OfferValidationsPaymentMethod**](OfferValidationsPaymentMethod.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferValidationsPaymentMethod.md b/docs/OfferValidationsPaymentMethod.md deleted file mode 100644 index 25c40d1..0000000 --- a/docs/OfferValidationsPaymentMethod.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.OfferValidationsPaymentMethod - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**all** | **Object** | All offers applicable | -**card** | [**CardOffer**](CardOffer.md) | | -**netbanking** | [**OfferNBNetbanking**](OfferNBNetbanking.md) | | -**app** | [**WalletOffer**](WalletOffer.md) | | -**upi** | **Object** | | -**paylater** | [**PaylaterOffer**](PaylaterOffer.md) | | -**emi** | [**EMIOffer**](EMIOffer.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OfferWallet.md b/docs/OfferWallet.md deleted file mode 100644 index ba61546..0000000 --- a/docs/OfferWallet.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.OfferWallet -Offer object for wallet payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**app** | [**WalletOffer**](WalletOffer.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Offers.md b/docs/Offers.md new file mode 100644 index 0000000..cf1cd17 --- /dev/null +++ b/docs/Offers.md @@ -0,0 +1,258 @@ +# Offers + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PGCreateOffer**](Offers.md#PGCreateOffer) | **Post** /offers | Create Offer +[**PGFetchOffer**](Offers.md#PGFetchOffer) | **Get** /offers/{offer_id} | Get Offer by ID + + + +## PGCreateOffer + +> PGCreateOffer(x_api_version: string, CreateOfferRequest: CreateOfferRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Create Offer ([Docs](https://docs.cashfree.com/reference/pgcreateoffer)) + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCreateOfferExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + createOfferRequest = new CreateOfferRequest + { + offer_meta = new OfferMeta + { + offer_title = "Test Offer", + offer_description = "Offer Description", + offer_code = "CFTESTOFFER", + offer_start_time = DateTime.Parse("2023-03-21T08:09:51Z"), + offer_end_time = DateTime.Parse("2024-03-21T08:09:51Z") + }, + offer_tnc = new OfferTnc + { + offer_tnc_type = "text", + offer_tnc_value = "Terms and Condition of the Offer" + }, + offer_details = new OfferDetails + { + offer_type = "DISCOUNT_AND_CASHBACK", + discount_details = new DiscountDetails + { + discount_type = "flat", + discount_value = "10", + max_discount_amount = "10" + }, + cashback_details = new CashbackDetails + { + cashback_type = "percentage", + cashback_value = "10", + max_cashback_amount = "10" + } + }, + offer_validations = new OfferValidations + { + payment_method = new PaymentMethod + { + card = new Card + { + type = new string[] { "cc" }, + bank_name = "hdfc bank", + scheme_name = new string[] { "visa" } + } + }, + min_amount = 15, + max_allowed = 100 + } + }; // CreateOfferRequest | Request body to create an offer at Cashfree + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Create Offer + OfferEntity result = cashfree.PGCreateOffer(xApiVersion, createOfferRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling OffersApi.PGCreateOffer: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**createOfferRequest** | **CreateOfferRequest*** | Request body to create an offer at Cashfree | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] +**xIdempotencyKey** | **Guid?** | 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. | [optional] + + +### Response +```json +{ + "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 + } +} +``` + + +## PGFetchOffer + +> PGFetchOffer(x_api_version: string, offer_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Offer by ID ([Docs](https://docs.cashfree.com/reference/pgfetchoffer)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGFetchOfferExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var offerId = d2b430fb-1afe-455a-af31-66d00377b29a; // string | The offer ID for which you want to view the offer details. + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Offer by ID + OfferEntity result = cashfree.PGFetchOffer(xApiVersion, offerId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling OffersApi.PGFetchOffer: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offerId** | **string** | The offer ID for which you want to view the offer details. | +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] +**xIdempotencyKey** | **Guid?** | 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. | [optional] | + + +### Response +```json +{ + "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 + } +} +``` \ No newline at end of file diff --git a/docs/OffersApi.md b/docs/OffersApi.md deleted file mode 100644 index 2fdf17d..0000000 --- a/docs/OffersApi.md +++ /dev/null @@ -1,187 +0,0 @@ -# cashfree_pg.Api.OffersApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGCreateOffer**](OffersApi.md#pgcreateoffer) | **POST** /offers | Create Offer | -| [**PGFetchOffer**](OffersApi.md#pgfetchoffer) | **GET** /offers/{offer_id} | Get Offer by ID | - - -# **PGCreateOffer** -> OfferEntity PGCreateOffer (string xApiVersion, CreateOfferRequest createOfferRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Create Offer - -Use this API to create offers with Cashfree from your backend - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCreateOfferExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var createOfferRequest = new CreateOfferRequest(); // CreateOfferRequest | Request body to create an offer at Cashfree - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Create Offer - OfferEntity result = cashfree.PGCreateOffer(xApiVersion, createOfferRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling OffersApi.PGCreateOffer: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **createOfferRequest** | [**CreateOfferRequest**](CreateOfferRequest.md) | Request body to create an offer at Cashfree | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**OfferEntity**](OfferEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGFetchOffer** -> OfferEntity PGFetchOffer (string xApiVersion, string offerId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Offer by ID - -Use this API to get offer by offer_id - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGFetchOfferExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var offerId = d2b430fb-1afe-455a-af31-66d00377b29a; // string | The offer ID for which you want to view the offer details. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Offer by ID - OfferEntity result = cashfree.PGFetchOffer(xApiVersion, offerId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling OffersApi.PGFetchOffer: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **offerId** | **string** | The offer ID for which you want to view the offer details. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**OfferEntity**](OfferEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/OrderAuthenticateEntity.md b/docs/OrderAuthenticateEntity.md deleted file mode 100644 index d08f098..0000000 --- a/docs/OrderAuthenticateEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.OrderAuthenticateEntity -This is the response shared when merchant inovkes the OTP submit or resend API - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_payment_id** | **string** | The payment id for which this request was sent | [optional] -**action** | **string** | The action that was invoked for this request. | [optional] -**authenticate_status** | **string** | 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. | [optional] -**payment_message** | **string** | Human readable message which describes the status in more detail | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OrderAuthenticatePaymentRequest.md b/docs/OrderAuthenticatePaymentRequest.md deleted file mode 100644 index 7c790a1..0000000 --- a/docs/OrderAuthenticatePaymentRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.OrderAuthenticatePaymentRequest -OTP to be submitted for headless/native OTP - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**otp** | **string** | OTP to be submitted | -**action** | **string** | The action for this workflow. Could be either SUBMIT_OTP or RESEND_OTP | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OrderCreateRefundRequest.md b/docs/OrderCreateRefundRequest.md deleted file mode 100644 index 098b809..0000000 --- a/docs/OrderCreateRefundRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.OrderCreateRefundRequest -create refund request object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**refund_amount** | **double** | Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed) | -**refund_id** | **string** | An unique ID to associate the refund with. Provie alphanumeric values | -**refund_note** | **string** | A refund note for your reference. | [optional] -**refund_speed** | **string** | Speed at which the refund is processed. It's an optional field with default being STANDARD | [optional] -**refund_splits** | [**List<VendorSplit>**](VendorSplit.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OrderEntity.md b/docs/OrderEntity.md deleted file mode 100644 index 75bc110..0000000 --- a/docs/OrderEntity.md +++ /dev/null @@ -1,24 +0,0 @@ -# cashfree_pg.Model.OrderEntity -The complete order entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_order_id** | **string** | unique id generated by cashfree for your order | [optional] -**order_id** | **string** | order_id sent during the api request | [optional] -**entity** | **string** | Type of the entity. | [optional] -**order_currency** | **string** | Currency of the order. Example INR | [optional] -**order_amount** | **decimal** | | [optional] -**order_status** | **string** | Possible values are - `ACTIVE`: Order does not have a sucessful transaction yet - `PAID`: Order is PAID with one successful transaction - `EXPIRED`: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order. `TERMINATED`: Order terminated `TERMINATION_REQUESTED`: Order termination requested | [optional] -**payment_session_id** | **string** | | [optional] -**order_expiry_time** | **DateTime** | | [optional] -**order_note** | **string** | Additional note for order | [optional] -**created_at** | **DateTime** | When the order was created at cashfree's server | [optional] -**order_splits** | [**List<VendorSplit>**](VendorSplit.md) | | [optional] -**customer_details** | [**CustomerDetails**](CustomerDetails.md) | | [optional] -**order_meta** | [**OrderMeta**](OrderMeta.md) | | [optional] -**order_tags** | **Dictionary<string, string>** | Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OrderMeta.md b/docs/OrderMeta.md deleted file mode 100644 index b301392..0000000 --- a/docs/OrderMeta.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.OrderMeta -Optional meta details to control how the customer pays and how payment journey completes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**return_url** | **string** | 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://example.com/return?order_id=myOrderId | [optional] -**notify_url** | **string** | Notification URL for server-server communication. Useful when user's connection drops while re-directing. NotifyUrl should be an https URL. Maximum length: 250. | [optional] -**payment_methods** | **Object** | 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 | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/OrderPayData.md b/docs/OrderPayData.md deleted file mode 100644 index 6140226..0000000 --- a/docs/OrderPayData.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.OrderPayData -the data object pay api - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **string** | | [optional] -**payload** | **Object** | | [optional] -**content_type** | **string** | | [optional] -**method** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Orders.md b/docs/Orders.md new file mode 100644 index 0000000..8423348 --- /dev/null +++ b/docs/Orders.md @@ -0,0 +1,236 @@ +# Orders + + +| Method | HTTP request | Description| +|----------------------------------------------| ------------- | -------------| + | [**PGCreateOrder**](Orders.md#PGCreateOrder) | **Post** /orders | Create Order| + | [**PGFetchOrder**](Orders.md#PGFetchOrder) | **Get** /orders/{order_id} | Get Order| + + + +## PGCreateOrder + +> PGCreateOrder(x_api_version: string, CreateOrderRequest: CreateOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Create Order ([Docs](https://docs.cashfree.com/reference/pgcreateorder)) + +### Example +```csharp +using System; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCreateOrderExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + var createOrderRequest = new CreateOrderRequest + { + order_amount = "1", + order_currency = "INR", + customer_details = new CustomerDetails + { + customer_id = "node_sdk_test", + customer_email = "example@gmail.com", + customer_phone = "9999999999" + }, + order_meta = new OrderMeta + { + return_url = "https://test.cashfree.com/pgappsdemos/return.php?order_id={order_id}" + } + }; + + try { + // Create Order + OrderEntity result = cashfree.PGCreateOrder(xApiVersion, createOrderRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling OrdersApi.PGCreateOrder: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + + + +### Parameters + +Other parameters are passed through a pointer to a apiPGCreateOrderRequest struct via the builder pattern + + +| Name | Type | Description | Notes| +|------------------------| ------------- | ------------- | -------------| +| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"]| +| **createOrderRequest** | [**CreateOrderRequest**](Orders.md#CreateOrderRequest) | Request body to create an order at cashfree | +| **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | +| **xIdempotencyKey** | **Guid?** | 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. | + +### CreateOrderRequest +| Name | Type | Description | Example| +|-----------------------| ------------- | ------------- | -------------| +| **order_id** | **string** (min 3, max 50, alphanumeric with _ and -) | The order ID identifies your order in the system. | order_8123| +| **order_amount** | **float*** (provide in two decimal places) | The order amount. | 101.12 (INR 101.12 implies rupees 101 and 12 paisa)| +| **order_currency** | **string*** | The order currency. We use the ISO 4217 currency list. | The order currency - INR.| +| **customer_details** | **object*** | This is a custom object which contains customer_details. The details of the customer such as: customer ID, name of the customer, email of the customer, phone number of the customer. | See below object.| +| **order_meta** | **object*** | This is a custom object which contains information about available payment methods for this order, webhook url and notify url. | See below object.| +| **order_expiry_time** | **string** | Time after which the order expires. This is the time after which customers will not be able to make any payment "attempt". Any delayed payment received from the bank side post this time (whose attempt was done within expiry time) will be reversed. | 2023-07-29T00:00:00Z +| **order_note** | **string** | Order note for reference purposes. | This order was created with Node SDK. + +### CustomerDetails +Name | Type | Description | Example +------------- | ------------- | ------------- | ------------- +**customer_id** | **string***(alphanumeric with - and _ allowed) | This is is the identifier for the customer in your system. | customer1234 +**customer_name** | **string**(Special characters are not allowed) | Name of your customer. | Cashfree Payments +**customer_email** | **string** | Email id of the customer | example@cashfree.com +**customer_phone** | **string*** | Phone of the customer. 10 digits phone number. | 8908908901 + +### OrderMeta +Name | Type | Description | Example +------------- | ------------- | ------------- | ------------- +**return_url** | **string** | This is the URL to which your customers will be redirected to after the payment. When a customer makes a card payment, they are redirected from your website to the bank's OTP page. From there, the customer is redirected back to your return url page. The return_url must contain a placeholder {order_id}. When redirecting the customer back to the return URL from the bank’s OTP page, Cashfree Payments will replace the placeholder with the actual value for that order. | https://merchant.in/pg/process_return?order_id={order_id} +**notify_url** | **string** | The webhook URL is required to get successful or failed webhooks after a payment on an order is completed. Only https URL allowed in production. http is allowed only in sandbox. | https://merchant.in/pg/process_webhook +**payment_methods** | **string** | List of payment modes. Use the following values - cc, dc, ccc, ppc, nb, upi, paypal, emi, app paylater. | "cc,dc,upi,nb" + +#### OrderEntity +```json +{ + "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" + }, + "entity": "order", + "order_amount": 22, + "order_currency": "INR", + "order_expiry_time": "2023-09-09T18:02:46+05:30", + "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij", + "order_meta": { + "return_url": "https://example.com/return/{order_id}", + "notify_url": "https://example.com/notify", + "payment_methods": "cc" + }, + "order_note": "some order note LIST", + "order_splits": [], + "order_status": "ACTIVE", + "order_tags": { + "name": "John", + "age": "19" + }, + "payment_session_id": "session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH" +} +``` + + +## PGFetchOrder + +> PGFetchOrder(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Order ([Docs](https://docs.cashfree.com/reference/pgfetchorder)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGFetchOrderExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = your-order-id; // string | The id which uniquely identifies your order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Order + OrderEntity result = cashfree.PGFetchOrder(xApiVersion, orderId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling OrdersApi.PGFetchOrder: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**orderId** | **string** | The id which uniquely identifies your order | +**xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree +**xIdempotencyKey** | **Guid?** | 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. +#### OrderEntity +```json +{ + "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" + }, + "entity": "order", + "order_amount": 22, + "order_currency": "INR", + "order_expiry_time": "2023-09-09T18:02:46+05:30", + "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij", + "order_meta": { + "return_url": "https://example.com/return/{order_id}", + "notify_url": "https://example.com/notify", + "payment_methods": "cc" + }, + "order_note": "some order note LIST", + "order_splits": [], + "order_status": "ACTIVE", + "order_tags": { + "name": "John", + "age": "19" + }, + "payment_session_id": "session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH" +} +``` diff --git a/docs/OrdersApi.md b/docs/OrdersApi.md deleted file mode 100644 index 9c52bdc..0000000 --- a/docs/OrdersApi.md +++ /dev/null @@ -1,279 +0,0 @@ -# cashfree_pg.Api.OrdersApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGCreateOrder**](OrdersApi.md#pgcreateorder) | **POST** /orders | Create Order | -| [**PGFetchOrder**](OrdersApi.md#pgfetchorder) | **GET** /orders/{order_id} | Get Order | -| [**PGTerminateOrder**](OrdersApi.md#pgterminateorder) | **PATCH** /orders/{order_id} | Terminate Order | - - -# **PGCreateOrder** -> OrderEntity PGCreateOrder (string xApiVersion, CreateOrderRequest createOrderRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Create Order - -### Order An order is an entity which has a amount and currency associated with it. It is something for which you want to collect payment for. Use this API to create orders with Cashfree from your backend to get a `payment_sessions_id`. You can use the `payment_sessions_id` to create a transaction for the order. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCreateOrderExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var createOrderRequest = new CreateOrderRequest(); // CreateOrderRequest | Request body to create an order at cashfree - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Create Order - OrderEntity result = cashfree.PGCreateOrder(xApiVersion, createOrderRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling OrdersApi.PGCreateOrder: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **createOrderRequest** | [**CreateOrderRequest**](CreateOrderRequest.md) | Request body to create an order at cashfree | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**OrderEntity**](OrderEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGFetchOrder** -> OrderEntity PGFetchOrder (string xApiVersion, string orderId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Order - -Use this API to fetch the order that was created at Cashfree's using the `order_id`. ## When to use this API - To check the status of your order - Once the order is PAID - Once your customer returns to `return_url` - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGFetchOrderExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Order - OrderEntity result = cashfree.PGFetchOrder(xApiVersion, orderId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling OrdersApi.PGFetchOrder: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**OrderEntity**](OrderEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGTerminateOrder** -> OrderEntity PGTerminateOrder (string xApiVersion, string orderId, TerminateOrderRequest terminateOrderRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Terminate Order - -Use this API to terminate the order that was created at Cashfree's using the `order_id`. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGTerminateOrderExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var terminateOrderRequest = new TerminateOrderRequest(); // TerminateOrderRequest | Request body to terminate an order at cashfree - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Terminate Order - OrderEntity result = cashfree.PGTerminateOrder(xApiVersion, orderId, terminateOrderRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling OrdersApi.PGTerminateOrder: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **terminateOrderRequest** | [**TerminateOrderRequest**](TerminateOrderRequest.md) | Request body to terminate an order at cashfree | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**OrderEntity**](OrderEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PGReconciliationApi.md b/docs/PGReconciliationApi.md deleted file mode 100644 index 2e3f39a..0000000 --- a/docs/PGReconciliationApi.md +++ /dev/null @@ -1,101 +0,0 @@ -# cashfree_pg.Api.PGReconciliationApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGFetchRecon**](PGReconciliationApi.md#pgfetchrecon) | **POST** /recon | PG Reconciliation | - - -# **PGFetchRecon** -> ReconEntity PGFetchRecon (string xApiVersion, FetchReconRequest fetchReconRequest, string? contentType = null, string? xRequestId = null, Guid? xIdempotencyKey = null, string? accept = null) - -PG Reconciliation - -- Use this API to get the payment gateway reconciliation details with date range. - It will have events for your payment account - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGFetchReconExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var fetchReconRequest = new FetchReconRequest(); // FetchReconRequest | Request Body for the reconciliation - var contentType = application/json; // string? | application/json (optional) - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var accept = application/json; // string? | application/json (optional) - - try - { - // PG Reconciliation - ReconEntity result = cashfree.PGFetchRecon(xApiVersion, fetchReconRequest, contentType, xRequestId, xIdempotencyKey, accept); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PGReconciliationApi.PGFetchRecon: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **fetchReconRequest** | [**FetchReconRequest**](FetchReconRequest.md) | Request Body for the reconciliation | | -| **contentType** | **string?** | application/json | [optional] | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **accept** | **string?** | application/json | [optional] | - -### Return type - -[**ReconEntity**](ReconEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PayOrderEntity.md b/docs/PayOrderEntity.md deleted file mode 100644 index 7e2c3c6..0000000 --- a/docs/PayOrderEntity.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.PayOrderEntity -Order Pay response once you create a transaction for that order - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_amount** | **decimal** | total amount payable | [optional] -**cf_payment_id** | **string** | Payment identifier created by Cashfree | [optional] -**payment_method** | **string** | One of [\"upi\", \"netbanking\", \"card\", \"app\", \"cardless_emi\", \"paylater\", \"banktransfer\"] | [optional] -**channel** | **string** | 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' | [optional] -**action** | **string** | One of [\"link\", \"custom\", \"form\"] | [optional] -**data** | [**OrderPayData**](OrderPayData.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PayOrderRequest.md b/docs/PayOrderRequest.md deleted file mode 100644 index 06be8be..0000000 --- a/docs/PayOrderRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.PayOrderRequest -Complete object for the pay api that uses payment method objects - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_session_id** | **string** | | -**payment_method** | [**PayOrderRequestPaymentMethod**](PayOrderRequestPaymentMethod.md) | | -**save_instrument** | **bool** | | [optional] -**offer_id** | **string** | This is required if any offers needs to be applied to the order. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PayOrderRequestPaymentMethod.md b/docs/PayOrderRequestPaymentMethod.md deleted file mode 100644 index 2994baf..0000000 --- a/docs/PayOrderRequestPaymentMethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# cashfree_pg.Model.PayOrderRequestPaymentMethod - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**Card**](Card.md) | | -**upi** | [**Upi**](Upi.md) | | -**netbanking** | [**Netbanking**](Netbanking.md) | | -**app** | [**App**](App.md) | | -**emi** | [**CardEMI**](CardEMI.md) | | -**cardless_emi** | [**CardlessEMI**](CardlessEMI.md) | | -**paylater** | [**Paylater**](Paylater.md) | | -**banktransfer** | [**Banktransfer**](Banktransfer.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Paylater.md b/docs/Paylater.md deleted file mode 100644 index dfaeed6..0000000 --- a/docs/Paylater.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.Paylater -Paylater payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | The channel for cardless EMI is always `link` | [optional] -**provider** | **string** | One of [\"kotak\", \"flexipay\", \"zestmoney\", \"lazypay\", \"olapostpaid\",\"simpl\", \"freechargepaylater\"]. Please note that Flexipay is offered by HDFC bank | [optional] -**phone** | **string** | 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' | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaylaterEntity.md b/docs/PaylaterEntity.md deleted file mode 100644 index 5be5a86..0000000 --- a/docs/PaylaterEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaylaterEntity -Paylater Entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_method** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaylaterOffer.md b/docs/PaylaterOffer.md deleted file mode 100644 index a92c2f8..0000000 --- a/docs/PaylaterOffer.md +++ /dev/null @@ -1,10 +0,0 @@ -# cashfree_pg.Model.PaylaterOffer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**provider** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaylaterPaymentMethod.md b/docs/PaylaterPaymentMethod.md deleted file mode 100644 index e62202a..0000000 --- a/docs/PaylaterPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaylaterPaymentMethod -paylater payment method - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paylater** | [**Paylater**](Paylater.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentEntity.md b/docs/PaymentEntity.md deleted file mode 100644 index 4dcf337..0000000 --- a/docs/PaymentEntity.md +++ /dev/null @@ -1,27 +0,0 @@ -# cashfree_pg.Model.PaymentEntity -payment entity full object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_payment_id** | **string** | | [optional] -**order_id** | **string** | | [optional] -**entity** | **string** | | [optional] -**error_details** | [**ErrorDetailsInPaymentsEntity**](ErrorDetailsInPaymentsEntity.md) | | [optional] -**is_captured** | **bool** | | [optional] -**order_amount** | **decimal** | Order amount can be different from payment amount if you collect service fee from the customer | [optional] -**payment_group** | **string** | 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'] | [optional] -**payment_currency** | **string** | | [optional] -**payment_amount** | **decimal** | | [optional] -**payment_time** | **string** | This is the time when the payment was initiated | [optional] -**payment_completion_time** | **string** | This is the time when the payment reaches its terminal state | [optional] -**payment_status** | **string** | The transaction status can be one of [\"SUCCESS\", \"NOT_ATTEMPTED\", \"FAILED\", \"USER_DROPPED\", \"VOID\", \"CANCELLED\", \"PENDING\"] | [optional] -**payment_message** | **string** | | [optional] -**bank_reference** | **string** | | [optional] -**auth_id** | **string** | | [optional] -**authorization** | [**AuthorizationInPaymentsEntity**](AuthorizationInPaymentsEntity.md) | | [optional] -**payment_method** | [**PaymentEntityPaymentMethod**](PaymentEntityPaymentMethod.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentEntityPaymentMethod.md b/docs/PaymentEntityPaymentMethod.md deleted file mode 100644 index a3eaad6..0000000 --- a/docs/PaymentEntityPaymentMethod.md +++ /dev/null @@ -1,17 +0,0 @@ -# cashfree_pg.Model.PaymentEntityPaymentMethod - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**PaymentMethodCardInPaymentsEntityCard**](PaymentMethodCardInPaymentsEntityCard.md) | | [optional] -**netbanking** | [**PaymentMethodNetBankingInPaymentsEntityNetbanking**](PaymentMethodNetBankingInPaymentsEntityNetbanking.md) | | [optional] -**upi** | [**PaymentMethodUPIInPaymentsEntityUpi**](PaymentMethodUPIInPaymentsEntityUpi.md) | | [optional] -**app** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] -**cardless_emi** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] -**paylater** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] -**emi** | [**PaymentMethodCardEMIInPaymentsEntityEmi**](PaymentMethodCardEMIInPaymentsEntityEmi.md) | | [optional] -**banktransfer** | [**PaymentMethodBankTransferInPaymentsEntityBanktransfer**](PaymentMethodBankTransferInPaymentsEntityBanktransfer.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentLinkCustomerDetails.md b/docs/PaymentLinkCustomerDetails.md deleted file mode 100644 index 841c7c5..0000000 --- a/docs/PaymentLinkCustomerDetails.md +++ /dev/null @@ -1,17 +0,0 @@ -# cashfree_pg.Model.PaymentLinkCustomerDetails -The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_id** | **string** | A unique identifier for the customer. Use alphanumeric values only. | [optional] -**customer_email** | **string** | Customer email address. | [optional] -**customer_phone** | **string** | Customer phone number. | -**customer_name** | **string** | Name of the customer. | [optional] -**customer_bank_account_number** | **string** | Customer bank account. Required if you want to do a bank account check (TPV) | [optional] -**customer_bank_ifsc** | **string** | Customer bank IFSC. Required if you want to do a bank account check (TPV) | [optional] -**customer_bank_code** | **decimal** | Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV) | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentLinkOrderEntity.md b/docs/PaymentLinkOrderEntity.md deleted file mode 100644 index fe0add0..0000000 --- a/docs/PaymentLinkOrderEntity.md +++ /dev/null @@ -1,25 +0,0 @@ -# cashfree_pg.Model.PaymentLinkOrderEntity -The complete order entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_order_id** | **string** | unique id generated by cashfree for your order | [optional] -**link_id** | **string** | link id of the order | [optional] -**order_id** | **string** | order_id sent during the api request | [optional] -**entity** | **string** | Type of the entity. | [optional] -**order_currency** | **string** | Currency of the order. Example INR | [optional] -**order_amount** | **decimal** | | [optional] -**order_status** | **string** | Possible values are - `ACTIVE`: Order does not have a sucessful transaction yet - `PAID`: Order is PAID with one successful transaction - `EXPIRED`: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order. | [optional] -**payment_session_id** | **string** | | [optional] -**order_expiry_time** | **DateTime** | | [optional] -**order_note** | **string** | Additional note for order | [optional] -**created_at** | **DateTime** | When the order was created at cashfree's server | [optional] -**order_splits** | [**List<VendorSplit>**](VendorSplit.md) | | [optional] -**customer_details** | [**PaymentLinkCustomerDetails**](PaymentLinkCustomerDetails.md) | | [optional] -**order_meta** | [**OrderMeta**](OrderMeta.md) | | [optional] -**order_tags** | **Dictionary<string, string>** | Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentLinksApi.md b/docs/PaymentLinksApi.md deleted file mode 100644 index 8ebc560..0000000 --- a/docs/PaymentLinksApi.md +++ /dev/null @@ -1,368 +0,0 @@ -# cashfree_pg.Api.PaymentLinksApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGCancelLink**](PaymentLinksApi.md#pgcancellink) | **POST** /links/{link_id}/cancel | Cancel Payment Link | -| [**PGCreateLink**](PaymentLinksApi.md#pgcreatelink) | **POST** /links | Create Payment Link | -| [**PGFetchLink**](PaymentLinksApi.md#pgfetchlink) | **GET** /links/{link_id} | Fetch Payment Link Details | -| [**PGLinkFetchOrders**](PaymentLinksApi.md#pglinkfetchorders) | **GET** /links/{link_id}/orders | Get Orders for a Payment Link | - - -# **PGCancelLink** -> LinkEntity PGCancelLink (string xApiVersion, string linkId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Cancel Payment Link - -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. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCancelLinkExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var linkId = your-link-id; // string | The payment link ID for which you want to view the details. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Cancel Payment Link - LinkEntity result = cashfree.PGCancelLink(xApiVersion, linkId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentLinksApi.PGCancelLink: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **linkId** | **string** | The payment link ID for which you want to view the details. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**LinkEntity**](LinkEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGCreateLink** -> LinkEntity PGCreateLink (string xApiVersion, CreateLinkRequest createLinkRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Create Payment Link - -Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCreateLinkExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var createLinkRequest = new CreateLinkRequest(); // CreateLinkRequest | Request Body to Create Payment Links - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Create Payment Link - LinkEntity result = cashfree.PGCreateLink(xApiVersion, createLinkRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentLinksApi.PGCreateLink: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **createLinkRequest** | [**CreateLinkRequest**](CreateLinkRequest.md) | Request Body to Create Payment Links | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**LinkEntity**](LinkEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGFetchLink** -> LinkEntity PGFetchLink (string xApiVersion, string linkId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Fetch Payment Link Details - -Use this API to view all details and status of a payment link. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGFetchLinkExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var linkId = your-link-id; // string | The payment link ID for which you want to view the details. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Fetch Payment Link Details - LinkEntity result = cashfree.PGFetchLink(xApiVersion, linkId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentLinksApi.PGFetchLink: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **linkId** | **string** | The payment link ID for which you want to view the details. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**LinkEntity**](LinkEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGLinkFetchOrders** -> List<PaymentLinkOrderEntity> PGLinkFetchOrders (string xApiVersion, string linkId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Orders for a Payment Link - -Use this API to view all order details for a payment link. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGLinkFetchOrdersExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var linkId = your-link-id; // string | The payment link ID for which you want to view the details. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Orders for a Payment Link - List result = cashfree.PGLinkFetchOrders(xApiVersion, linkId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentLinksApi.PGLinkFetchOrders: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **linkId** | **string** | The payment link ID for which you want to view the details. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<PaymentLinkOrderEntity>**](PaymentLinkOrderEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodAppInPaymentsEntity.md b/docs/PaymentMethodAppInPaymentsEntity.md deleted file mode 100644 index eb7a377..0000000 --- a/docs/PaymentMethodAppInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodAppInPaymentsEntity -payment method app object in payment entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**app** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodAppInPaymentsEntityApp.md b/docs/PaymentMethodAppInPaymentsEntityApp.md deleted file mode 100644 index e2eb2c0..0000000 --- a/docs/PaymentMethodAppInPaymentsEntityApp.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.PaymentMethodAppInPaymentsEntityApp - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | | [optional] -**provider** | **string** | | [optional] -**phone** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodBankTransferInPaymentsEntity.md b/docs/PaymentMethodBankTransferInPaymentsEntity.md deleted file mode 100644 index 4382dcb..0000000 --- a/docs/PaymentMethodBankTransferInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodBankTransferInPaymentsEntity -payment method bank transfer object in payment entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**banktransfer** | [**PaymentMethodBankTransferInPaymentsEntityBanktransfer**](PaymentMethodBankTransferInPaymentsEntityBanktransfer.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodBankTransferInPaymentsEntityBanktransfer.md b/docs/PaymentMethodBankTransferInPaymentsEntityBanktransfer.md deleted file mode 100644 index b479001..0000000 --- a/docs/PaymentMethodBankTransferInPaymentsEntityBanktransfer.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.PaymentMethodBankTransferInPaymentsEntityBanktransfer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | | [optional] -**banktransfer_bank_name** | **string** | | [optional] -**banktransfer_ifsc** | **string** | | [optional] -**banktransfer_account_number** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodCardEMIInPaymentsEntity.md b/docs/PaymentMethodCardEMIInPaymentsEntity.md deleted file mode 100644 index 6a102ed..0000000 --- a/docs/PaymentMethodCardEMIInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodCardEMIInPaymentsEntity -payment method card emi object in payment entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emi** | [**PaymentMethodCardEMIInPaymentsEntityEmi**](PaymentMethodCardEMIInPaymentsEntityEmi.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodCardEMIInPaymentsEntityEmi.md b/docs/PaymentMethodCardEMIInPaymentsEntityEmi.md deleted file mode 100644 index 128d27a..0000000 --- a/docs/PaymentMethodCardEMIInPaymentsEntityEmi.md +++ /dev/null @@ -1,18 +0,0 @@ -# cashfree_pg.Model.PaymentMethodCardEMIInPaymentsEntityEmi - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | | [optional] -**card_number** | **string** | | [optional] -**card_network** | **string** | | [optional] -**card_type** | **string** | | [optional] -**card_country** | **string** | | [optional] -**card_bank_name** | **string** | | [optional] -**card_network_reference_id** | **string** | | [optional] -**emi_tenure** | **decimal** | | [optional] -**emi_details** | [**PaymentMethodCardEMIInPaymentsEntityEmiEmiDetails**](PaymentMethodCardEMIInPaymentsEntityEmiEmiDetails.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodCardEMIInPaymentsEntityEmiEmiDetails.md b/docs/PaymentMethodCardEMIInPaymentsEntityEmiEmiDetails.md deleted file mode 100644 index 80a6f6d..0000000 --- a/docs/PaymentMethodCardEMIInPaymentsEntityEmiEmiDetails.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.PaymentMethodCardEMIInPaymentsEntityEmiEmiDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emi_amount** | **decimal** | | [optional] -**emi_tenure** | **decimal** | | [optional] -**emi_interest** | **decimal** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodCardInPaymentsEntity.md b/docs/PaymentMethodCardInPaymentsEntity.md deleted file mode 100644 index 847d57c..0000000 --- a/docs/PaymentMethodCardInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodCardInPaymentsEntity -payment method card object in payment entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**PaymentMethodCardInPaymentsEntityCard**](PaymentMethodCardInPaymentsEntityCard.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodCardInPaymentsEntityCard.md b/docs/PaymentMethodCardInPaymentsEntityCard.md deleted file mode 100644 index 1407841..0000000 --- a/docs/PaymentMethodCardInPaymentsEntityCard.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.PaymentMethodCardInPaymentsEntityCard - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | | [optional] -**card_number** | **string** | | [optional] -**card_network** | **string** | | [optional] -**card_type** | **string** | | [optional] -**card_country** | **string** | | [optional] -**card_bank_name** | **string** | | [optional] -**card_network_reference_id** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodCardlessEMIInPaymentsEntity.md b/docs/PaymentMethodCardlessEMIInPaymentsEntity.md deleted file mode 100644 index 666c0de..0000000 --- a/docs/PaymentMethodCardlessEMIInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodCardlessEMIInPaymentsEntity -payment method carless object in payment entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cardless_emi** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodInPaymentsEntity.md b/docs/PaymentMethodInPaymentsEntity.md deleted file mode 100644 index a61243a..0000000 --- a/docs/PaymentMethodInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodInPaymentsEntity -payment methods all - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_method** | [**PaymentMethodInPaymentsEntityPaymentMethod**](PaymentMethodInPaymentsEntityPaymentMethod.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodInPaymentsEntityPaymentMethod.md b/docs/PaymentMethodInPaymentsEntityPaymentMethod.md deleted file mode 100644 index d8abc06..0000000 --- a/docs/PaymentMethodInPaymentsEntityPaymentMethod.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.PaymentMethodInPaymentsEntityPaymentMethod - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**PaymentMethodCardInPaymentsEntityCard**](PaymentMethodCardInPaymentsEntityCard.md) | | [optional] -**netbanking** | [**PaymentMethodNetBankingInPaymentsEntityNetbanking**](PaymentMethodNetBankingInPaymentsEntityNetbanking.md) | | [optional] -**upi** | [**PaymentMethodUPIInPaymentsEntityUpi**](PaymentMethodUPIInPaymentsEntityUpi.md) | | [optional] -**app** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] -**cardless_emi** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] -**paylater** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] -**emi** | [**PaymentMethodCardEMIInPaymentsEntityEmi**](PaymentMethodCardEMIInPaymentsEntityEmi.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodNetBankingInPaymentsEntity.md b/docs/PaymentMethodNetBankingInPaymentsEntity.md deleted file mode 100644 index 66b8b51..0000000 --- a/docs/PaymentMethodNetBankingInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodNetBankingInPaymentsEntity -netbanking payment method object for pay - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**netbanking** | [**PaymentMethodNetBankingInPaymentsEntityNetbanking**](PaymentMethodNetBankingInPaymentsEntityNetbanking.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodNetBankingInPaymentsEntityNetbanking.md b/docs/PaymentMethodNetBankingInPaymentsEntityNetbanking.md deleted file mode 100644 index b11d44a..0000000 --- a/docs/PaymentMethodNetBankingInPaymentsEntityNetbanking.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.PaymentMethodNetBankingInPaymentsEntityNetbanking - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | | [optional] -**netbanking_bank_code** | **int** | | [optional] -**netbanking_bank_name** | **string** | | [optional] -**netbanking_ifsc** | **string** | | [optional] -**netbanking_account_number** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodPaylaterInPaymentsEntity.md b/docs/PaymentMethodPaylaterInPaymentsEntity.md deleted file mode 100644 index 8faa79e..0000000 --- a/docs/PaymentMethodPaylaterInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodPaylaterInPaymentsEntity -paylater payment method object for pay api - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paylater** | [**PaymentMethodAppInPaymentsEntityApp**](PaymentMethodAppInPaymentsEntityApp.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodUPIInPaymentsEntity.md b/docs/PaymentMethodUPIInPaymentsEntity.md deleted file mode 100644 index 20ee95f..0000000 --- a/docs/PaymentMethodUPIInPaymentsEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodUPIInPaymentsEntity -UPI payment method for pay api - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**upi** | [**PaymentMethodUPIInPaymentsEntityUpi**](PaymentMethodUPIInPaymentsEntityUpi.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodUPIInPaymentsEntityUpi.md b/docs/PaymentMethodUPIInPaymentsEntityUpi.md deleted file mode 100644 index a73f35e..0000000 --- a/docs/PaymentMethodUPIInPaymentsEntityUpi.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodUPIInPaymentsEntityUpi - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | | [optional] -**upi_id** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodsFilters.md b/docs/PaymentMethodsFilters.md deleted file mode 100644 index 7683c6f..0000000 --- a/docs/PaymentMethodsFilters.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentMethodsFilters -Filter for Payment Methods - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_methods** | **List<string>** | 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' ] | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodsQueries.md b/docs/PaymentMethodsQueries.md deleted file mode 100644 index 0741f35..0000000 --- a/docs/PaymentMethodsQueries.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.PaymentMethodsQueries -Payment Method Query Object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount** | **decimal** | Amount of the order. | [optional] -**order_id** | **string** | OrderId of the order. Either of `order_id` or `order_amount` is mandatory. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentModeDetails.md b/docs/PaymentModeDetails.md deleted file mode 100644 index 726d611..0000000 --- a/docs/PaymentModeDetails.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.PaymentModeDetails -payment mode eligiblity object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**nick** | **string** | | [optional] -**display** | **string** | | [optional] -**eligibility** | **bool** | | [optional] -**code** | **decimal** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentSuccessWebhook.md b/docs/PaymentSuccessWebhook.md deleted file mode 100644 index 298a829..0000000 --- a/docs/PaymentSuccessWebhook.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.PaymentSuccessWebhook -object for payment success webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**WHdata**](WHdata.md) | | [optional] -**event_time** | **string** | | [optional] -**type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentURLObject.md b/docs/PaymentURLObject.md deleted file mode 100644 index e0a4d5f..0000000 --- a/docs/PaymentURLObject.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentURLObject -URL for payment retrieval for an order - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentWebhook.md b/docs/PaymentWebhook.md deleted file mode 100644 index f570326..0000000 --- a/docs/PaymentWebhook.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.PaymentWebhook -payment webhook object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**PaymentWebhookDataEntity**](PaymentWebhookDataEntity.md) | | [optional] -**event_time** | **string** | | [optional] -**type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentWebhookCustomerEntity.md b/docs/PaymentWebhookCustomerEntity.md deleted file mode 100644 index 699356e..0000000 --- a/docs/PaymentWebhookCustomerEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.PaymentWebhookCustomerEntity -customer details object in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_name** | **string** | | [optional] -**customer_id** | **string** | | [optional] -**customer_email** | **string** | | [optional] -**customer_phone** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentWebhookDataEntity.md b/docs/PaymentWebhookDataEntity.md deleted file mode 100644 index 963f300..0000000 --- a/docs/PaymentWebhookDataEntity.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.PaymentWebhookDataEntity -data entity in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order** | [**PaymentWebhookOrderEntity**](PaymentWebhookOrderEntity.md) | | [optional] -**payment** | [**PaymentEntity**](PaymentEntity.md) | | [optional] -**customer_details** | [**PaymentWebhookCustomerEntity**](PaymentWebhookCustomerEntity.md) | | [optional] -**error_details** | [**PaymentWebhookErrorEntity**](PaymentWebhookErrorEntity.md) | | [optional] -**payment_gateway_details** | [**PaymentWebhookGatewayDetailsEntity**](PaymentWebhookGatewayDetailsEntity.md) | | [optional] -**payment_offers** | [**List<OfferEntity>**](OfferEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentWebhookDataEntity1.md b/docs/PaymentWebhookDataEntity1.md deleted file mode 100644 index 8abbac7..0000000 --- a/docs/PaymentWebhookDataEntity1.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.PaymentWebhookDataEntity1 -data entity in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**refund** | [**RefundEntity**](RefundEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentWebhookErrorEntity.md b/docs/PaymentWebhookErrorEntity.md deleted file mode 100644 index d2ba462..0000000 --- a/docs/PaymentWebhookErrorEntity.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.PaymentWebhookErrorEntity -error details present in the webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error_code** | **string** | | [optional] -**error_description** | **string** | | [optional] -**error_reason** | **string** | | [optional] -**error_source** | **string** | | [optional] -**error_code_raw** | **string** | | [optional] -**error_description_raw** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentWebhookGatewayDetailsEntity.md b/docs/PaymentWebhookGatewayDetailsEntity.md deleted file mode 100644 index a67e815..0000000 --- a/docs/PaymentWebhookGatewayDetailsEntity.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.PaymentWebhookGatewayDetailsEntity -payment gatewat details present in the webhook response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**gateway_name** | **string** | | [optional] -**gateway_order_id** | **string** | | [optional] -**gateway_payment_id** | **string** | | [optional] -**gateway_status_code** | **string** | | [optional] -**gateway_settlement** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentWebhookOrderEntity.md b/docs/PaymentWebhookOrderEntity.md deleted file mode 100644 index 252e2e8..0000000 --- a/docs/PaymentWebhookOrderEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.PaymentWebhookOrderEntity -order entity in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order_id** | **string** | | [optional] -**order_amount** | **double** | | [optional] -**order_currency** | **string** | | [optional] -**order_tags** | **Dictionary<string, string>** | Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md deleted file mode 100644 index e68dd57..0000000 --- a/docs/PaymentsApi.md +++ /dev/null @@ -1,468 +0,0 @@ -# cashfree_pg.Api.PaymentsApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGAuthorizeOrder**](PaymentsApi.md#pgauthorizeorder) | **POST** /orders/{order_id}/authorization | Preauthorization | -| [**PGOrderAuthenticatePayment**](PaymentsApi.md#pgorderauthenticatepayment) | **POST** /orders/pay/authenticate/{cf_payment_id} | Submit or Resend OTP | -| [**PGOrderFetchPayment**](PaymentsApi.md#pgorderfetchpayment) | **GET** /orders/{order_id}/payments/{cf_payment_id} | Get Payment by ID | -| [**PGOrderFetchPayments**](PaymentsApi.md#pgorderfetchpayments) | **GET** /orders/{order_id}/payments | Get Payments for an Order | -| [**PGPayOrder**](PaymentsApi.md#pgpayorder) | **POST** /orders/sessions | Order Pay | - - -# **PGAuthorizeOrder** -> PaymentEntity PGAuthorizeOrder (string xApiVersion, string orderId, AuthorizeOrderRequest authorizeOrderRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Preauthorization - -Use this API to capture or void a preauthorized payment - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGAuthorizeOrderExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var authorizeOrderRequest = new AuthorizeOrderRequest(); // AuthorizeOrderRequest | Request to Capture or Void Transactions - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Preauthorization - PaymentEntity result = cashfree.PGAuthorizeOrder(xApiVersion, orderId, authorizeOrderRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentsApi.PGAuthorizeOrder: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **authorizeOrderRequest** | [**AuthorizeOrderRequest**](AuthorizeOrderRequest.md) | Request to Capture or Void Transactions | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**PaymentEntity**](PaymentEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGOrderAuthenticatePayment** -> OrderAuthenticateEntity PGOrderAuthenticatePayment (string xApiVersion, string cfPaymentId, OrderAuthenticatePaymentRequest orderAuthenticatePaymentRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Submit or Resend OTP - -If you accept OTP on your own page, you can use the below API to send OTP to Cashfree. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderAuthenticatePaymentExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var cfPaymentId = 121224562; // string | The Cashfree payment or transaction ID. - var orderAuthenticatePaymentRequest = new OrderAuthenticatePaymentRequest(); // OrderAuthenticatePaymentRequest | Request body to submit/resend headless OTP. To use this API make sure you have headless OTP enabled for your account - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Submit or Resend OTP - OrderAuthenticateEntity result = cashfree.PGOrderAuthenticatePayment(xApiVersion, cfPaymentId, orderAuthenticatePaymentRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentsApi.PGOrderAuthenticatePayment: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **cfPaymentId** | **string** | The Cashfree payment or transaction ID. | | -| **orderAuthenticatePaymentRequest** | [**OrderAuthenticatePaymentRequest**](OrderAuthenticatePaymentRequest.md) | Request body to submit/resend headless OTP. To use this API make sure you have headless OTP enabled for your account | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**OrderAuthenticateEntity**](OrderAuthenticateEntity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGOrderFetchPayment** -> PaymentEntity PGOrderFetchPayment (string xApiVersion, string orderId, string cfPaymentId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Payment by ID - -Use this API to view payment details of an order for a payment ID. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderFetchPaymentExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var cfPaymentId = 121224562; // string | The Cashfree payment or transaction ID. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Payment by ID - PaymentEntity result = cashfree.PGOrderFetchPayment(xApiVersion, orderId, cfPaymentId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentsApi.PGOrderFetchPayment: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **cfPaymentId** | **string** | The Cashfree payment or transaction ID. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**PaymentEntity**](PaymentEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGOrderFetchPayments** -> List<PaymentEntity> PGOrderFetchPayments (string xApiVersion, string orderId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Payments for an Order - -Use this API to view all payment details for an order. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderFetchPaymentsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Payments for an Order - List result = cashfree.PGOrderFetchPayments(xApiVersion, orderId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentsApi.PGOrderFetchPayments: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<PaymentEntity>**](PaymentEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | List of payment enttity | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGPayOrder** -> PayOrderEntity PGPayOrder (string xApiVersion, PayOrderRequest payOrderRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Order Pay - -Use this API when you have already created the orders and want Cashfree to process the payment. To use this API S2S flag needs to be enabled from the backend. In case you want to use the cards payment option the PCI DSS flag is required, for more information send an email to \"care@cashfree.com\". - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGPayOrderExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var payOrderRequest = new PayOrderRequest(); // PayOrderRequest | Request body to create a transaction at cashfree using `payment_session_id` - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Order Pay - PayOrderEntity result = cashfree.PGPayOrder(xApiVersion, payOrderRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling PaymentsApi.PGPayOrder: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **payOrderRequest** | [**PayOrderRequest**](PayOrderRequest.md) | Request body to create a transaction at cashfree using `payment_session_id` | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**PayOrderEntity**](PayOrderEntity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/RateLimitError.md b/docs/RateLimitError.md deleted file mode 100644 index 7c6f31d..0000000 --- a/docs/RateLimitError.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.RateLimitError -Error when rate limit is breached for your api - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **string** | | [optional] -**code** | **string** | | [optional] -**type** | **string** | rate_limit_error | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ReconEntity.md b/docs/ReconEntity.md deleted file mode 100644 index 62dfc1e..0000000 --- a/docs/ReconEntity.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.ReconEntity -Settlement detailed recon response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cursor** | **string** | Specifies from where the next set of settlement details should be fetched. | [optional] -**limit** | **int** | Number of settlements you want to fetch in the next iteration. | [optional] -**data** | [**List<ReconEntityDataInner>**](ReconEntityDataInner.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ReconEntityDataInner.md b/docs/ReconEntityDataInner.md deleted file mode 100644 index 723f403..0000000 --- a/docs/ReconEntityDataInner.md +++ /dev/null @@ -1,56 +0,0 @@ -# cashfree_pg.Model.ReconEntityDataInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**event_id** | **string** | Unique ID associated with the event. | [optional] -**event_type** | **string** | The event type can be SETTLEMENT, PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT. | [optional] -**event_settlement_amount** | **decimal** | Amount that is part of the settlement corresponding to the event. | [optional] -**event_amount** | **decimal** | Amount of the event. Example, refund amount, dispute amount, payment amount, etc. | [optional] -**sale_type** | **string** | Indicates if it is CREDIT/DEBIT sale. | [optional] -**event_status** | **string** | Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED. | [optional] -**entity** | **string** | Recon | [optional] -**event_time** | **string** | Time associated with the event. Example, transaction time, dispute initiation time | [optional] -**event_currency** | **string** | Curreny type - INR. | [optional] -**order_id** | **string** | Unique order ID. Alphanumeric and only '-' and '_' allowed. | [optional] -**order_amount** | **decimal** | The amount which was passed at the order creation time. | [optional] -**customer_phone** | **string** | Customer phone number. | [optional] -**customer_email** | **string** | Customer email. | [optional] -**customer_name** | **string** | Customer name. | [optional] -**payment_amount** | **decimal** | Payment amount captured. | [optional] -**payment_utr** | **string** | Unique transaction reference number of the payment. | [optional] -**payment_time** | **string** | Date and time when the payment was initiated. | [optional] -**payment_service_charge** | **decimal** | Service charge applicable for the payment. | [optional] -**payment_service_tax** | **decimal** | Service tax applicable on the payment. | [optional] -**cf_payment_id** | **string** | Cashfree Payments unique ID to identify a payment. | [optional] -**cf_settlement_id** | **string** | Unique ID to identify the settlement. | [optional] -**settlement_date** | **string** | Date and time when the settlement was processed. | [optional] -**settlement_utr** | **string** | Unique transaction reference number of the settlement. | [optional] -**split_service_charge** | **decimal** | Service charge that is applicable for splitting the payment. | [optional] -**split_service_tax** | **decimal** | Service tax applicable for splitting the amount to vendors. | [optional] -**vendor_commission** | **decimal** | Vendor commission applicable for this transaction. | [optional] -**closed_in_favor_of** | **string** | Specifies whether the dispute was closed in favor of the merchant or customer. /n Possible values - Merchant, Customer | [optional] -**dispute_resolved_on** | **string** | Date and time when the dispute was resolved. | [optional] -**dispute_category** | **string** | Category of the dispute - Dispute code and the reason for dispute is shown. | [optional] -**dispute_note** | **string** | Note regarding the dispute. | [optional] -**refund_processed_at** | **string** | Date and time when the refund was processed. | [optional] -**refund_arn** | **string** | The bank reference number for the refund. | [optional] -**refund_note** | **string** | A refund note for your reference. | [optional] -**refund_id** | **string** | An unique ID to associate the refund with. | [optional] -**adjustment_remarks** | **string** | Other adjustment remarks. | [optional] -**adjustment** | **decimal** | Amount that is adjusted from the settlement amount because of any credit/debit event such as refund, refund_reverse etc. | [optional] -**service_tax** | **decimal** | Service tax applicable on the settlement amount. | [optional] -**service_charge** | **decimal** | Service charge applicable on the settlement amount. | [optional] -**amount_settled** | **decimal** | Net amount that is settled after considering the adjustments, settlement charge and tax. | [optional] -**payment_from** | **string** | The start time of the time range of the payments considered for the settlement. | [optional] -**payment_till** | **string** | The end time of time range of the payments considered for the settlement. | [optional] -**reason** | **string** | Reason for settlement failure. | [optional] -**settlement_initiated_on** | **string** | Date and time when the settlement was initiated. | [optional] -**settlement_type** | **string** | Type of settlement. Possible values - Standard, Instant, On demand. | [optional] -**settlement_charge** | **decimal** | Settlement charges applicable on the settlement. | [optional] -**settlement_tax** | **decimal** | Settlement tax applicable on the settlement. | [optional] -**remarks** | **string** | Remarks on the settlement. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Reconciliation.md b/docs/Reconciliation.md new file mode 100644 index 0000000..28c2cfa --- /dev/null +++ b/docs/Reconciliation.md @@ -0,0 +1,280 @@ +# PGReconciliation + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PGFetchRecon**](PGReconciliation.md#PGFetchRecon) | **Post** /recon | PG Reconciliation + +## PGFetchRecon + +> PGFetchRecon(x_api_version: string, FetchReconRequest: FetchReconRequest, Content_Type?: string, +> x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): +> Promise> + +PG Reconciliation ([Docs](https://docs.cashfree.com/reference/pgfetchrecon)) + +### Example + +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGFetchReconExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var fetchReconRequest = new RequestObject + { + pagination = new Pagination + { + limit = 10, + cursor = "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==" + }, + filters = new Filters + { + start_date = DateTime.Parse("2022-07-20T00:00:00Z"), + end_date = DateTime.Parse("2022-07-21T23:59:59Z") + } + }; // FetchReconRequest | Request Body for the reconciliation + var contentType = application/json; // string? | application/json (optional) + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + var accept = application/json; // string? | application/json (optional) + + try + { + // PG Reconciliation + ReconEntity result = cashfree.PGFetchRecon(xApiVersion, fetchReconRequest, contentType, xRequestId, xIdempotencyKey, accept); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PGReconciliationApi.PGFetchRecon: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ----------- | ------------- | ------------- +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**fetchReconRequest** | [**FetchReconRequest**](FetchReconRequest.md) | Request Body for the reconciliation | +**contentType** | **string** | application/json | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | +**accept** | **string** | application/json | +**xIdempotencyKey** | **Guid?** | 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. | [optional] + + +### ReconEntity + +```json +{ + "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" + }, + { + "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" + }, + { + "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" + }, + { + "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" + }, + { + "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" + } + ] +} +``` \ No newline at end of file diff --git a/docs/RefundEntity.md b/docs/RefundEntity.md deleted file mode 100644 index b4f38f2..0000000 --- a/docs/RefundEntity.md +++ /dev/null @@ -1,29 +0,0 @@ -# cashfree_pg.Model.RefundEntity -The refund entity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_payment_id** | **string** | Cashfree Payments ID of the payment for which refund is initiated | [optional] -**cf_refund_id** | **string** | Cashfree Payments ID for a refund | [optional] -**order_id** | **string** | Merchant’s order Id of the order for which refund is initiated | [optional] -**refund_id** | **string** | Merchant’s refund ID of the refund | [optional] -**entity** | **string** | Type of object | [optional] -**refund_amount** | **decimal** | Amount that is refunded | [optional] -**refund_currency** | **string** | Currency of the refund amount | [optional] -**refund_note** | **string** | Note added by merchant for the refund | [optional] -**refund_status** | **string** | This can be one of [\"SUCCESS\", \"PENDING\", \"CANCELLED\", \"ONHOLD\", \"FAILED\"] | [optional] -**refund_arn** | **string** | The bank reference number for refund | [optional] -**refund_charge** | **decimal** | Charges in INR for processing refund | [optional] -**status_description** | **string** | Description of refund status | [optional] -**metadata** | **Object** | Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs | [optional] -**refund_splits** | [**List<VendorSplit>**](VendorSplit.md) | | [optional] -**refund_type** | **string** | This can be one of [\"PAYMENT_AUTO_REFUND\", \"MERCHANT_INITIATED\", \"UNRECONCILED_AUTO_REFUND\"] | [optional] -**refund_mode** | **string** | Method or speed of processing refund | [optional] -**created_at** | **string** | Time of refund creation | [optional] -**processed_at** | **string** | Time when refund was processed successfully | [optional] -**refund_speed** | [**RefundSpeed**](RefundSpeed.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RefundSpeed.md b/docs/RefundSpeed.md deleted file mode 100644 index 546fd8e..0000000 --- a/docs/RefundSpeed.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.RefundSpeed -How fast refund has to be proecessed - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requested** | **string** | Requested speed of refund. | [optional] -**accepted** | **string** | Accepted speed of refund. | [optional] -**processed** | **string** | Processed speed of refund. | [optional] -**message** | **string** | Error message, if any for refund_speed request | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RefundURLObject.md b/docs/RefundURLObject.md deleted file mode 100644 index 96c724b..0000000 --- a/docs/RefundURLObject.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.RefundURLObject -URL to get refunds for order - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RefundWebhook.md b/docs/RefundWebhook.md deleted file mode 100644 index 9a45bfd..0000000 --- a/docs/RefundWebhook.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.RefundWebhook -refund webhook object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**RefundWebhookDataEntity**](RefundWebhookDataEntity.md) | | [optional] -**event_time** | **string** | | [optional] -**type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RefundWebhookDataEntity.md b/docs/RefundWebhookDataEntity.md deleted file mode 100644 index 9e100c9..0000000 --- a/docs/RefundWebhookDataEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.RefundWebhookDataEntity -data entity in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**refund** | [**RefundEntity**](RefundEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RefundsApi.md b/docs/RefundsApi.md deleted file mode 100644 index aad272d..0000000 --- a/docs/RefundsApi.md +++ /dev/null @@ -1,283 +0,0 @@ -# cashfree_pg.Api.RefundsApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGOrderCreateRefund**](RefundsApi.md#pgordercreaterefund) | **POST** /orders/{order_id}/refunds | Create Refund | -| [**PGOrderFetchRefund**](RefundsApi.md#pgorderfetchrefund) | **GET** /orders/{order_id}/refunds/{refund_id} | Get Refund | -| [**PGOrderFetchRefunds**](RefundsApi.md#pgorderfetchrefunds) | **GET** /orders/{order_id}/refunds | Get All Refunds for an Order | - - -# **PGOrderCreateRefund** -> RefundEntity PGOrderCreateRefund (string xApiVersion, string orderId, OrderCreateRefundRequest orderCreateRefundRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Create Refund - -Use this API to initiate refunds. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderCreateRefundExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var orderCreateRefundRequest = new OrderCreateRefundRequest(); // OrderCreateRefundRequest | Request Body to Create Refunds - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Create Refund - RefundEntity result = cashfree.PGOrderCreateRefund(xApiVersion, orderId, orderCreateRefundRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RefundsApi.PGOrderCreateRefund: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **orderCreateRefundRequest** | [**OrderCreateRefundRequest**](OrderCreateRefundRequest.md) | Request Body to Create Refunds | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**RefundEntity**](RefundEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Refund created | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGOrderFetchRefund** -> RefundEntity PGOrderFetchRefund (string xApiVersion, string orderId, string refundId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Refund - -Use this API to fetch a specific refund processed on your Cashfree Account. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderFetchRefundExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var refundId = some-refund-id; // string | Refund Id of the refund you want to fetch. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Refund - RefundEntity result = cashfree.PGOrderFetchRefund(xApiVersion, orderId, refundId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RefundsApi.PGOrderFetchRefund: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **refundId** | **string** | Refund Id of the refund you want to fetch. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**RefundEntity**](RefundEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGOrderFetchRefunds** -> List<RefundEntity> PGOrderFetchRefunds (string xApiVersion, string orderId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get All Refunds for an Order - -Use this API to fetch all refunds processed against an order. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderFetchRefundsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get All Refunds for an Order - List result = cashfree.PGOrderFetchRefunds(xApiVersion, orderId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling RefundsApi.PGOrderFetchRefunds: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<RefundEntity>**](RefundEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SavedInstrumentMeta.md b/docs/SavedInstrumentMeta.md deleted file mode 100644 index c231bf7..0000000 --- a/docs/SavedInstrumentMeta.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.SavedInstrumentMeta -Card instrument meta information - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card_network** | **string** | card scheme/network of the saved card. Example visa, mastercard | [optional] -**card_bank_name** | **string** | Issuing bank name of saved card | [optional] -**card_country** | **string** | Issuing country of saved card | [optional] -**card_type** | **string** | Type of saved card | [optional] -**card_token_details** | **Object** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ScheduleOption.md b/docs/ScheduleOption.md deleted file mode 100644 index 4ce355e..0000000 --- a/docs/ScheduleOption.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.ScheduleOption - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**settlement_schedule_message** | **string** | | [optional] -**schedule_id** | **decimal** | | [optional] -**merchant_default** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementEntity.md b/docs/SettlementEntity.md deleted file mode 100644 index e48100f..0000000 --- a/docs/SettlementEntity.md +++ /dev/null @@ -1,24 +0,0 @@ -# cashfree_pg.Model.SettlementEntity -Settlement entity object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_payment_id** | **string** | | [optional] -**cf_settlement_id** | **string** | | [optional] -**settlement_currency** | **string** | | [optional] -**order_id** | **string** | | [optional] -**entity** | **string** | | [optional] -**order_amount** | **decimal** | | [optional] -**payment_time** | **string** | | [optional] -**service_charge** | **decimal** | | [optional] -**service_tax** | **decimal** | | [optional] -**settlement_amount** | **decimal** | | [optional] -**settlement_id** | **int** | | [optional] -**transfer_id** | **int** | | [optional] -**transfer_time** | **string** | | [optional] -**transfer_utr** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementFetchReconRequest.md b/docs/SettlementFetchReconRequest.md deleted file mode 100644 index 856fc57..0000000 --- a/docs/SettlementFetchReconRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.SettlementFetchReconRequest -Recon Request Object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pagination** | [**FetchSettlementsRequestPagination**](FetchSettlementsRequestPagination.md) | | -**filters** | [**FetchSettlementsRequestFilters**](FetchSettlementsRequestFilters.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementFetchReconRequestFilters.md b/docs/SettlementFetchReconRequestFilters.md deleted file mode 100644 index 4b822f8..0000000 --- a/docs/SettlementFetchReconRequestFilters.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.SettlementFetchReconRequestFilters -Specify either the Settlement ID, Settlement UTR, or start date and end date to fetch the settlement details. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_settlement_ids** | **List<int>** | List of settlement IDs for which you want the settlement reconciliation details. | [optional] -**settlement_utrs** | **List<string>** | List of settlement UTRs for which you want the settlement reconciliation details. | [optional] -**start_date** | **string** | Specify the start date from when you want the settlement reconciliation details. | [optional] -**end_date** | **string** | Specify the end date till when you want the settlement reconciliation details. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementReconEntity.md b/docs/SettlementReconEntity.md deleted file mode 100644 index 707b12a..0000000 --- a/docs/SettlementReconEntity.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.SettlementReconEntity -Recon object for settlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cursor** | **string** | Specifies from where the next set of settlement details should be fetched. | [optional] -**limit** | **int** | Number of settlements you want to fetch in the next iteration. | [optional] -**data** | [**List<SettlementReconEntityDataInner>**](SettlementReconEntityDataInner.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementReconEntityDataInner.md b/docs/SettlementReconEntityDataInner.md deleted file mode 100644 index 48c8121..0000000 --- a/docs/SettlementReconEntityDataInner.md +++ /dev/null @@ -1,44 +0,0 @@ -# cashfree_pg.Model.SettlementReconEntityDataInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**event_id** | **string** | Unique ID associated with the event. | [optional] -**event_type** | **string** | The event type can be PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT. | [optional] -**event_settlement_amount** | **decimal** | Amount that is part of the settlement corresponding to the event. | [optional] -**event_amount** | **decimal** | Amount corresponding to the event. Example, refund amount, dispute amount, payment amount, etc. | [optional] -**sale_type** | **string** | Indicates if it is CREDIT/DEBIT sale. | [optional] -**event_status** | **string** | Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED. | [optional] -**entity** | **string** | Recon | [optional] -**event_time** | **string** | Time associated with the event. Example, transaction time, dispute initiation time | [optional] -**event_currency** | **string** | Curreny type - INR. | [optional] -**order_id** | **string** | Unique order ID. Alphanumeric and only '-' and '_' allowed. | [optional] -**order_amount** | **decimal** | The amount which was passed at the order creation time. | [optional] -**customer_phone** | **string** | Customer phone number. | [optional] -**customer_email** | **string** | Customer email. | [optional] -**customer_name** | **string** | Customer name. | [optional] -**payment_amount** | **decimal** | Payment amount captured. | [optional] -**payment_utr** | **string** | Unique transaction reference number of the payment. | [optional] -**payment_time** | **string** | Date and time when the payment was initiated. | [optional] -**payment_service_charge** | **decimal** | Service charge applicable for the payment. | [optional] -**payment_service_tax** | **decimal** | Service tax applicable on the payment. | [optional] -**cf_payment_id** | **string** | Cashfree Payments unique ID to identify a payment. | [optional] -**cf_settlement_id** | **string** | Unique ID to identify the settlement. | [optional] -**settlement_date** | **string** | Date and time when the settlement was processed. | [optional] -**settlement_utr** | **string** | Unique transaction reference number of the settlement. | [optional] -**split_service_charge** | **decimal** | Service charge that is applicable for splitting the payment. | [optional] -**split_service_tax** | **decimal** | Service tax applicable for splitting the amount to vendors. | [optional] -**vendor_commission** | **decimal** | Vendor commission applicable for this transaction. | [optional] -**closed_in_favor_of** | **string** | Specifies whether the dispute was closed in favor of the merchant or customer. Possible values - Merchant, Customer. | [optional] -**dispute_resolved_on** | **string** | Date and time when the dispute was resolved. | [optional] -**dispute_category** | **string** | Category of the dispute - Dispute code and the reason for dispute is shown. | [optional] -**dispute_note** | **string** | Note regarding the dispute. | [optional] -**refund_processed_at** | **string** | Date and time when the refund was processed. | [optional] -**refund_arn** | **string** | The bank reference number for refund. | [optional] -**refund_note** | **string** | A refund note for your reference. | [optional] -**refund_id** | **string** | An unique ID associated with the refund. | [optional] -**adjustment_remarks** | **string** | Other adjustment remarks. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementReconciliationApi.md b/docs/SettlementReconciliationApi.md deleted file mode 100644 index 7b38d6c..0000000 --- a/docs/SettlementReconciliationApi.md +++ /dev/null @@ -1,195 +0,0 @@ -# cashfree_pg.Api.SettlementReconciliationApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGFetchSettlements**](SettlementReconciliationApi.md#pgfetchsettlements) | **POST** /settlements | Get All Settlements | -| [**PGSettlementFetchRecon**](SettlementReconciliationApi.md#pgsettlementfetchrecon) | **POST** /settlement/recon | Settlement Reconciliation | - - -# **PGFetchSettlements** -> SettlementEntity PGFetchSettlements (string xApiVersion, FetchSettlementsRequest fetchSettlementsRequest, string? contentType = null, string? xRequestId = null, Guid? xIdempotencyKey = null, string? accept = null) - -Get All Settlements - -Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGFetchSettlementsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var fetchSettlementsRequest = new FetchSettlementsRequest(); // FetchSettlementsRequest | Request Body to get the settlements - var contentType = application/json; // string? | application/json (optional) - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var accept = application/json; // string? | application/json (optional) - - try - { - // Get All Settlements - SettlementEntity result = cashfree.PGFetchSettlements(xApiVersion, fetchSettlementsRequest, contentType, xRequestId, xIdempotencyKey, accept); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SettlementReconciliationApi.PGFetchSettlements: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **fetchSettlementsRequest** | [**FetchSettlementsRequest**](FetchSettlementsRequest.md) | Request Body to get the settlements | | -| **contentType** | **string?** | application/json | [optional] | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **accept** | **string?** | application/json | [optional] | - -### Return type - -[**SettlementEntity**](SettlementEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGSettlementFetchRecon** -> SettlementReconEntity PGSettlementFetchRecon (string xApiVersion, SettlementFetchReconRequest settlementFetchReconRequest, string? contentType = null, string? xRequestId = null, Guid? xIdempotencyKey = null, string? accept = null) - -Settlement Reconciliation - -- Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. - This API will return events for the settlement IDs you want - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGSettlementFetchReconExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var settlementFetchReconRequest = new SettlementFetchReconRequest(); // SettlementFetchReconRequest | Request Body for the settlement reconciliation - var contentType = application/json; // string? | application/json (optional) - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - var accept = application/json; // string? | application/json (optional) - - try - { - // Settlement Reconciliation - SettlementReconEntity result = cashfree.PGSettlementFetchRecon(xApiVersion, settlementFetchReconRequest, contentType, xRequestId, xIdempotencyKey, accept); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SettlementReconciliationApi.PGSettlementFetchRecon: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **settlementFetchReconRequest** | [**SettlementFetchReconRequest**](SettlementFetchReconRequest.md) | Request Body for the settlement reconciliation | | -| **contentType** | **string?** | application/json | [optional] | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | -| **accept** | **string?** | application/json | [optional] | - -### Return type - -[**SettlementReconEntity**](SettlementReconEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SettlementURLObject.md b/docs/SettlementURLObject.md deleted file mode 100644 index 1ff4b93..0000000 --- a/docs/SettlementURLObject.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.SettlementURLObject -Settlement URL object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**url** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementWebhook.md b/docs/SettlementWebhook.md deleted file mode 100644 index b2223eb..0000000 --- a/docs/SettlementWebhook.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.SettlementWebhook -Settlement webhook object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**SettlementWebhookDataEntity**](SettlementWebhookDataEntity.md) | | [optional] -**event_time** | **string** | | [optional] -**type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SettlementWebhookDataEntity.md b/docs/SettlementWebhookDataEntity.md deleted file mode 100644 index 20537b0..0000000 --- a/docs/SettlementWebhookDataEntity.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.SettlementWebhookDataEntity -data entity in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**settlement** | [**SettlementEntity**](SettlementEntity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Settlements.md b/docs/Settlements.md new file mode 100644 index 0000000..9cdd655 --- /dev/null +++ b/docs/Settlements.md @@ -0,0 +1,89 @@ +# Settlements + +| Method | HTTP request | Description | +|-------| ------------- | -------------| +| [**PGOrderFetchSettlement**](Settlements.md#PGOrderFetchSettlement) | **Get** /orders/{order_id}/settlements | Get Settlements by Order ID| + + + +## PGOrderFetchSettlement + +> PGOrderFetchSettlement(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Settlements by Order ID ([Docs](https://docs.cashfree.com/reference/pgorderfetchsettlement) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGOrderFetchSettlementExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = your-order-id; // string | The id which uniquely identifies your order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Settlements by Order ID + SettlementEntity result = cashfree.PGOrderFetchSettlement(xApiVersion, orderId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling SettlementsApi.PGOrderFetchSettlement: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + + +### Parameters + +| Name | Type | Description | Notes| +|---------------------| ------------- | ------------- | -------------| +| **orderId** | **string** | The id which uniquely identifies your order | +| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"]| +| **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + | **xIdempotencyKey** | **Guid?** | 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. | [optional] | + + +### Response + +```SettlementEntity +{ + "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" +} +``` \ No newline at end of file diff --git a/docs/SettlementsApi.md b/docs/SettlementsApi.md deleted file mode 100644 index 50df722..0000000 --- a/docs/SettlementsApi.md +++ /dev/null @@ -1,98 +0,0 @@ -# cashfree_pg.Api.SettlementsApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGOrderFetchSettlement**](SettlementsApi.md#pgorderfetchsettlement) | **GET** /orders/{order_id}/settlements | Get Settlements by Order ID | - - -# **PGOrderFetchSettlement** -> SettlementEntity PGOrderFetchSettlement (string xApiVersion, string orderId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Settlements by Order ID - -Use this API to view all the settlements of a particular order. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGOrderFetchSettlementExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Settlements by Order ID - SettlementEntity result = cashfree.PGOrderFetchSettlement(xApiVersion, orderId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SettlementsApi.PGOrderFetchSettlement: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **orderId** | **string** | The id which uniquely identifies your order | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**SettlementEntity**](SettlementEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SoftPOSApi.md b/docs/SoftPOSApi.md deleted file mode 100644 index b539660..0000000 --- a/docs/SoftPOSApi.md +++ /dev/null @@ -1,737 +0,0 @@ -# cashfree_pg.Api.SoftPOSApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**SposCreateTerminal**](SoftPOSApi.md#sposcreateterminal) | **POST** /terminal | Create Terminal | -| [**SposCreateTerminalTransaction**](SoftPOSApi.md#sposcreateterminaltransaction) | **POST** /terminal/transactions | Create Terminal Transaction | -| [**SposFetchTerminal**](SoftPOSApi.md#sposfetchterminal) | **GET** /terminal/{terminal_phone_no} | Get Terminal Status using Phone Number | -| [**SposFetchTerminalQRCodes**](SoftPOSApi.md#sposfetchterminalqrcodes) | **GET** /terminal/qrcodes | Fetch Terminal QR Codes | -| [**SposFetchTerminalTransaction**](SoftPOSApi.md#sposfetchterminaltransaction) | **GET** /terminal/{cf_terminal_id}/payments | Get Terminal Transaction | -| [**SposUpdateTerminal**](SoftPOSApi.md#sposupdateterminal) | **PATCH** /terminal/{cf_terminal_id} | Update Terminal | -| [**SposUpdateTerminalStatus**](SoftPOSApi.md#sposupdateterminalstatus) | **PATCH** /terminal/{cf_terminal_id}/status | Update Terminal Status | -| [**SposUploadTerminalDocs**](SoftPOSApi.md#sposuploadterminaldocs) | **POST** /terminal/{cf_terminal_id}/docs | Upload Terminal Docs | - - -# **SposCreateTerminal** -> TerminalEntity SposCreateTerminal (string xApiVersion, CreateTerminalRequest createTerminalRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Create Terminal - -Use this API to create new terminals to use softPOS. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposCreateTerminalExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var createTerminalRequest = new CreateTerminalRequest(); // CreateTerminalRequest | Request Body to Create Terminal for SPOS - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Create Terminal - TerminalEntity result = cashfree.SposCreateTerminal(xApiVersion, createTerminalRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposCreateTerminal: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **createTerminalRequest** | [**CreateTerminalRequest**](CreateTerminalRequest.md) | Request Body to Create Terminal for SPOS | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**TerminalEntity**](TerminalEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Terminal created | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SposCreateTerminalTransaction** -> TerminalTransactionEntity SposCreateTerminalTransaction (string xApiVersion, CreateTerminalTransactionRequest createTerminalTransactionRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Create Terminal Transaction - -Use this API to create a new terminal transaction. To use this API you should first create an order using the Create Order API. Also, you need to enter the terminal details while creating the order and pass the same terminal information while creating a transaction using the below mentioned API. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposCreateTerminalTransactionExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var createTerminalTransactionRequest = new CreateTerminalTransactionRequest(); // CreateTerminalTransactionRequest | Request body to create a terminal transaction - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Create Terminal Transaction - TerminalTransactionEntity result = cashfree.SposCreateTerminalTransaction(xApiVersion, createTerminalTransactionRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposCreateTerminalTransaction: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **createTerminalTransactionRequest** | [**CreateTerminalTransactionRequest**](CreateTerminalTransactionRequest.md) | Request body to create a terminal transaction | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**TerminalTransactionEntity**](TerminalTransactionEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Terminal Transaction created | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SposFetchTerminal** -> TerminalEntity SposFetchTerminal (string xApiVersion, string terminalPhoneNo, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Terminal Status using Phone Number - -Use this API to view all details of a terminal. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposFetchTerminalExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var terminalPhoneNo = 6309291183; // string | The terminal for which you want to view the order details. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Terminal Status using Phone Number - TerminalEntity result = cashfree.SposFetchTerminal(xApiVersion, terminalPhoneNo, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposFetchTerminal: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **terminalPhoneNo** | **string** | The terminal for which you want to view the order details. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**TerminalEntity**](TerminalEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SposFetchTerminalQRCodes** -> List<FetchTerminalQRCodesEntity> SposFetchTerminalQRCodes (string xApiVersion, string terminalPhoneNo, string cfTerminalId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Fetch Terminal QR Codes - -You can fetch all the StaticQRs corresponding to given terminal id or phone number. Provide either the terminal_phone_no or terminal_id in the request. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposFetchTerminalQRCodesExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var terminalPhoneNo = 9876543214; // string | Phone number assigned to the terminal. Required if you are not providing the cf_terminal_id in the request. - var cfTerminalId = 123344; // string | Cashfree terminal id for which you want to get staticQRs. Required if you are not providing the terminal_phone_number in the request. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Fetch Terminal QR Codes - List result = cashfree.SposFetchTerminalQRCodes(xApiVersion, terminalPhoneNo, cfTerminalId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposFetchTerminalQRCodes: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **terminalPhoneNo** | **string** | Phone number assigned to the terminal. Required if you are not providing the cf_terminal_id in the request. | | -| **cfTerminalId** | **string** | Cashfree terminal id for which you want to get staticQRs. Required if you are not providing the terminal_phone_number in the request. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<FetchTerminalQRCodesEntity>**](FetchTerminalQRCodesEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Fetched Terminal QR Codes | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SposFetchTerminalTransaction** -> TerminalPaymentEntity SposFetchTerminalTransaction (string xApiVersion, string utr, string cfTerminalId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Get Terminal Transaction - -Use this API to get terminal transaction. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposFetchTerminalTransactionExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var utr = testUTR001; // string | Utr of the transaction. - var cfTerminalId = 123344; // string | Provide the Cashfree terminal ID for which the details have to be updated. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Get Terminal Transaction - TerminalPaymentEntity result = cashfree.SposFetchTerminalTransaction(xApiVersion, utr, cfTerminalId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposFetchTerminalTransaction: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **utr** | **string** | Utr of the transaction. | | -| **cfTerminalId** | **string** | Provide the Cashfree terminal ID for which the details have to be updated. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**TerminalPaymentEntity**](TerminalPaymentEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Fetch Terminal Transaction | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SposUpdateTerminal** -> List<UpdateTerminalEntity> SposUpdateTerminal (string xApiVersion, string cfTerminalId, UpdateTerminalRequest updateTerminalRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Update Terminal - -Use this API to update the terminal details. Email, Phone Number, and Terminal Meta are updatable for \"Storefront\". Only account status change is possible in case of \"Agent\". - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposUpdateTerminalExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var cfTerminalId = 123344; // string | Provide the Cashfree terminal ID for which the details have to be updated. - var updateTerminalRequest = new UpdateTerminalRequest(); // UpdateTerminalRequest | Request Body to update terminal for SPOS. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Update Terminal - List result = cashfree.SposUpdateTerminal(xApiVersion, cfTerminalId, updateTerminalRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposUpdateTerminal: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **cfTerminalId** | **string** | Provide the Cashfree terminal ID for which the details have to be updated. | | -| **updateTerminalRequest** | [**UpdateTerminalRequest**](UpdateTerminalRequest.md) | Request Body to update terminal for SPOS. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<UpdateTerminalEntity>**](UpdateTerminalEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Updated Terminal | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SposUpdateTerminalStatus** -> List<UpdateTerminalEntity> SposUpdateTerminalStatus (string xApiVersion, string cfTerminalId, UpdateTerminalStatusRequest updateTerminalStatusRequest, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Update Terminal Status - -Use this API to update the terminal status. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposUpdateTerminalStatusExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var cfTerminalId = 123344; // string | Provide the Cashfree terminal ID for which the details have to be updated. - var updateTerminalStatusRequest = new UpdateTerminalStatusRequest(); // UpdateTerminalStatusRequest | Request Body to update terminal status for SPOS. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Update Terminal Status - List result = cashfree.SposUpdateTerminalStatus(xApiVersion, cfTerminalId, updateTerminalStatusRequest, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposUpdateTerminalStatus: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **cfTerminalId** | **string** | Provide the Cashfree terminal ID for which the details have to be updated. | | -| **updateTerminalStatusRequest** | [**UpdateTerminalStatusRequest**](UpdateTerminalStatusRequest.md) | Request Body to update terminal status for SPOS. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<UpdateTerminalEntity>**](UpdateTerminalEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Updated Terminal Status | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **SposUploadTerminalDocs** -> List<UploadTerminalDocsEntity> SposUploadTerminalDocs (string xApiVersion, string cfTerminalId, UploadTerminalDocs uploadTerminalDocs, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Upload Terminal Docs - -Use this API to upload the terminal documents. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class SposUploadTerminalDocsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var cfTerminalId = 123344; // string | Provide the Cashfree terminal ID for which the details have to be updated. - var uploadTerminalDocs = new UploadTerminalDocs(); // UploadTerminalDocs | Request Body to update terminal documents for SPOS. - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Upload Terminal Docs - List result = cashfree.SposUploadTerminalDocs(xApiVersion, cfTerminalId, uploadTerminalDocs, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SoftPOSApi.SposUploadTerminalDocs: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **cfTerminalId** | **string** | Provide the Cashfree terminal ID for which the details have to be updated. | | -| **uploadTerminalDocs** | [**UploadTerminalDocs**](UploadTerminalDocs.md) | Request Body to update terminal documents for SPOS. | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<UploadTerminalDocsEntity>**](UploadTerminalDocsEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Upload Terminal Docs | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SplitAfterPaymentRequest.md b/docs/SplitAfterPaymentRequest.md deleted file mode 100644 index e4d88dc..0000000 --- a/docs/SplitAfterPaymentRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.SplitAfterPaymentRequest -Split After Payment Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**split** | [**List<SplitAfterPaymentRequestSplitInner>**](SplitAfterPaymentRequestSplitInner.md) | Specify the vendors order split details. | -**disable_split** | **bool** | Specify if you want to end the split or continue creating further splits in future. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SplitAfterPaymentRequestSplitInner.md b/docs/SplitAfterPaymentRequestSplitInner.md deleted file mode 100644 index 1d10a97..0000000 --- a/docs/SplitAfterPaymentRequestSplitInner.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.SplitAfterPaymentRequestSplitInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vendor_id** | **string** | Specify the merchant vendor ID to split the payment. | [optional] -**amount** | **decimal** | Specify the amount to be split to the vendor. | [optional] -**percentage** | **decimal** | Specify the percentage of amount to be split. | [optional] -**tags** | **Dictionary<string, string>** | Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SplitAfterPaymentRequestSplitInnerTagsInner.md b/docs/SplitAfterPaymentRequestSplitInnerTagsInner.md deleted file mode 100644 index 36ca2d5..0000000 --- a/docs/SplitAfterPaymentRequestSplitInnerTagsInner.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.SplitAfterPaymentRequestSplitInnerTagsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key_Value_1** | **string** | | [optional] -**Key_Value_2** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SplitAfterPaymentResponse.md b/docs/SplitAfterPaymentResponse.md deleted file mode 100644 index 660c2e3..0000000 --- a/docs/SplitAfterPaymentResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# cashfree_pg.Model.SplitAfterPaymentResponse -Split After Payment Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **string** | | [optional] -**message** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StaticSplitRequest.md b/docs/StaticSplitRequest.md deleted file mode 100644 index 93e8104..0000000 --- a/docs/StaticSplitRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.StaticSplitRequest -Static Split Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**active** | **bool** | Specify if the split is to be active or not. Possible values: true/false | -**terminal_id** | **string** | 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. | [optional] -**terminal_reference_id** | **decimal** | You can share additional information using the reference ID. | [optional] -**product_type** | **string** | 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** | [**List<StaticSplitRequestSchemeInner>**](StaticSplitRequestSchemeInner.md) | Provide the split scheme details. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StaticSplitRequestSchemeInner.md b/docs/StaticSplitRequestSchemeInner.md deleted file mode 100644 index d22732a..0000000 --- a/docs/StaticSplitRequestSchemeInner.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.StaticSplitRequestSchemeInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantVendorId** | **string** | Specify the merchant vendor ID to create the split scheme for the payment. | [optional] -**percentage** | **string** | Specify the percentage of amount to be split. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StaticSplitResponse.md b/docs/StaticSplitResponse.md deleted file mode 100644 index 9553451..0000000 --- a/docs/StaticSplitResponse.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.StaticSplitResponse -Static Split Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**active** | **bool** | | [optional] -**terminal_id** | **string** | | [optional] -**terminal_reference_id** | **decimal** | | [optional] -**product_type** | **string** | | [optional] -**scheme** | [**List<StaticSplitResponseSchemeInner>**](StaticSplitResponseSchemeInner.md) | | [optional] -**added_on** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StaticSplitResponseSchemeInner.md b/docs/StaticSplitResponseSchemeInner.md deleted file mode 100644 index b0736ec..0000000 --- a/docs/StaticSplitResponseSchemeInner.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.StaticSplitResponseSchemeInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantVendorId** | **string** | | [optional] -**percentage** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TerminalDetails.md b/docs/TerminalDetails.md deleted file mode 100644 index f9a663c..0000000 --- a/docs/TerminalDetails.md +++ /dev/null @@ -1,20 +0,0 @@ -# cashfree_pg.Model.TerminalDetails -Use this if you are creating an order for cashfree's softPOS - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**added_on** | **string** | date time at which terminal is added | [optional] -**cf_terminal_id** | **string** | cashfree terminal id | [optional] -**last_updated_on** | **string** | last instant when this terminal was updated | [optional] -**terminal_address** | **string** | location of terminal | [optional] -**terminal_id** | **string** | terminal id for merchant reference | -**terminal_name** | **string** | name of terminal/agent/storefront | [optional] -**terminal_note** | **string** | note given by merchant while creating the terminal | [optional] -**terminal_phone_no** | **string** | mobile num of the terminal/agent/storefront | -**terminal_status** | **string** | status of terminal active/inactive | [optional] -**terminal_type** | **string** | To identify the type of terminal product in use, in this case it is SPOS. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TerminalEntity.md b/docs/TerminalEntity.md deleted file mode 100644 index 82de001..0000000 --- a/docs/TerminalEntity.md +++ /dev/null @@ -1,22 +0,0 @@ -# cashfree_pg.Model.TerminalEntity -Create terminal response object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**added_on** | **string** | | [optional] -**cf_terminal_id** | **int** | | [optional] -**last_updated_on** | **string** | | [optional] -**terminal_address** | **string** | | [optional] -**terminal_email** | **string** | | [optional] -**terminal_type** | **string** | | [optional] -**teminal_id** | **string** | | [optional] -**terminal_name** | **string** | | [optional] -**terminal_note** | **string** | | [optional] -**terminal_phone_no** | **string** | | [optional] -**terminal_status** | **string** | | [optional] -**terminal_meta** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TerminalPaymentEntity.md b/docs/TerminalPaymentEntity.md deleted file mode 100644 index 8c5a1b9..0000000 --- a/docs/TerminalPaymentEntity.md +++ /dev/null @@ -1,28 +0,0 @@ -# cashfree_pg.Model.TerminalPaymentEntity -terminal payment entity full object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_payment_id** | **string** | | [optional] -**order_id** | **string** | | [optional] -**entity** | **string** | | [optional] -**error_details** | [**ErrorDetailsInPaymentsEntity**](ErrorDetailsInPaymentsEntity.md) | | [optional] -**is_captured** | **bool** | | [optional] -**order_amount** | **decimal** | Order amount can be different from payment amount if you collect service fee from the customer | [optional] -**payment_group** | **string** | 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'] | [optional] -**payment_currency** | **string** | | [optional] -**payment_amount** | **decimal** | | [optional] -**payment_time** | **string** | This is the time when the payment was initiated | [optional] -**payment_completion_time** | **string** | This is the time when the payment reaches its terminal state | [optional] -**payment_status** | **string** | The transaction status can be one of [\"SUCCESS\", \"NOT_ATTEMPTED\", \"FAILED\", \"USER_DROPPED\", \"VOID\", \"CANCELLED\", \"PENDING\"] | [optional] -**payment_message** | **string** | | [optional] -**bank_reference** | **string** | | [optional] -**auth_id** | **string** | | [optional] -**authorization** | [**AuthorizationInPaymentsEntity**](AuthorizationInPaymentsEntity.md) | | [optional] -**customer_details** | [**CustomerDetails**](CustomerDetails.md) | | [optional] -**payment_method** | [**PaymentEntityPaymentMethod**](PaymentEntityPaymentMethod.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TerminalTransactionEntity.md b/docs/TerminalTransactionEntity.md deleted file mode 100644 index f55ce41..0000000 --- a/docs/TerminalTransactionEntity.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.TerminalTransactionEntity -Create terminal response object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_payment_id** | **string** | | [optional] -**payment_amount** | **int** | | [optional] -**payment_method** | **string** | | [optional] -**payment_url** | **string** | | [optional] -**qrcode** | **string** | | [optional] -**timeout** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TerminateOrderRequest.md b/docs/TerminateOrderRequest.md deleted file mode 100644 index b1aadb6..0000000 --- a/docs/TerminateOrderRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.TerminateOrderRequest -Request to terminate an active order at Cashfree - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order_status** | **string** | To terminate an order, pass order_status as \"TERMINATE\". 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. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TokenVaultApi.md b/docs/TokenVaultApi.md deleted file mode 100644 index 32694b2..0000000 --- a/docs/TokenVaultApi.md +++ /dev/null @@ -1,378 +0,0 @@ -# cashfree_pg.Api.TokenVaultApi - -All URIs are relative to *https://sandbox.cashfree.com/pg* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**PGCustomerDeleteInstrument**](TokenVaultApi.md#pgcustomerdeleteinstrument) | **DELETE** /customers/{customer_id}/instruments/{instrument_id} | Delete Saved Card Instrument | -| [**PGCustomerFetchInstrument**](TokenVaultApi.md#pgcustomerfetchinstrument) | **GET** /customers/{customer_id}/instruments/{instrument_id} | Fetch Specific Saved Card Instrument | -| [**PGCustomerFetchInstruments**](TokenVaultApi.md#pgcustomerfetchinstruments) | **GET** /customers/{customer_id}/instruments | Fetch All Saved Card Instrument | -| [**PGCustomerInstrumentsFetchCryptogram**](TokenVaultApi.md#pgcustomerinstrumentsfetchcryptogram) | **GET** /customers/{customer_id}/instruments/{instrument_id}/cryptogram | Fetch cryptogram for a saved card instrument | - - -# **PGCustomerDeleteInstrument** -> InstrumentEntity PGCustomerDeleteInstrument (string xApiVersion, string customerId, string instrumentId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Delete Saved Card Instrument - -Use this API to delete a saved card instrument for a customer_id and instrument_id - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCustomerDeleteInstrumentExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var customerId = your-customer-id; // string | Your Customer ID that you had sent during create order API `POST/orders` - var instrumentId = some-instrument-id; // string | The instrument_id which needs to be deleted - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Delete Saved Card Instrument - InstrumentEntity result = cashfree.PGCustomerDeleteInstrument(xApiVersion, customerId, instrumentId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling TokenVaultApi.PGCustomerDeleteInstrument: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **customerId** | **string** | Your Customer ID that you had sent during create order API `POST/orders` | | -| **instrumentId** | **string** | The instrument_id which needs to be deleted | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**InstrumentEntity**](InstrumentEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGCustomerFetchInstrument** -> InstrumentEntity PGCustomerFetchInstrument (string xApiVersion, string customerId, string instrumentId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Fetch Specific Saved Card Instrument - -Use this API to fetch a single specific saved card for a customer_id by it's instrument_id - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCustomerFetchInstrumentExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var customerId = your-customer-id; // string | Your Customer ID that you had sent during create order API `POST/orders` - var instrumentId = some-instrument-id; // string | The instrument_id of the saved instrument which needs to be queried - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Fetch Specific Saved Card Instrument - InstrumentEntity result = cashfree.PGCustomerFetchInstrument(xApiVersion, customerId, instrumentId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling TokenVaultApi.PGCustomerFetchInstrument: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **customerId** | **string** | Your Customer ID that you had sent during create order API `POST/orders` | | -| **instrumentId** | **string** | The instrument_id of the saved instrument which needs to be queried | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**InstrumentEntity**](InstrumentEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGCustomerFetchInstruments** -> List<InstrumentEntity> PGCustomerFetchInstruments (string xApiVersion, string customerId, string instrumentType, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Fetch All Saved Card Instrument - -Use this API to fetch saved cards for a customer_id - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCustomerFetchInstrumentsExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var customerId = your-customer-id; // string | Your Customer ID that you had sent during create order API `POST/orders` - var instrumentType = card; // string | Payment mode or type of saved instrument - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Fetch All Saved Card Instrument - List result = cashfree.PGCustomerFetchInstruments(xApiVersion, customerId, instrumentType, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling TokenVaultApi.PGCustomerFetchInstruments: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **customerId** | **string** | Your Customer ID that you had sent during create order API `POST/orders` | | -| **instrumentType** | **string** | Payment mode or type of saved instrument | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**List<InstrumentEntity>**](InstrumentEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **PGCustomerInstrumentsFetchCryptogram** -> CryptogramEntity PGCustomerInstrumentsFetchCryptogram (string xApiVersion, string customerId, string instrumentId, string? xRequestId = null, Guid? xIdempotencyKey = null) - -Fetch cryptogram for a saved card instrument - -Use this API To get the card network token, token expiry and cryptogram for a saved card instrument using instrument id - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using cashfree_pg.Client; -using cashfree_pg.Model; - -namespace Example -{ - public class PGCustomerInstrumentsFetchCryptogramExample - { - public static void Main() - { - // Configuration - Cashfree.XClientId = ""; - Cashfree.XClientSecret = ""; - Cashfree.XEnvironment = Cashfree.SANDBOX; - - // Instance of Cashfree - var cashfree = new Cashfree(); - - - var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var customerId = your-customer-id; // string | Your Customer ID that you had sent during create order API `POST/orders` - var instrumentId = some-instrument-id; // string | The instrument_id of the saved card instrument which needs to be queried - var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) - var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) - - try - { - // Fetch cryptogram for a saved card instrument - CryptogramEntity result = cashfree.PGCustomerInstrumentsFetchCryptogram(xApiVersion, customerId, instrumentId, xRequestId, xIdempotencyKey); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling TokenVaultApi.PGCustomerInstrumentsFetchCryptogram: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2023-08-01"] | -| **customerId** | **string** | Your Customer ID that you had sent during create order API `POST/orders` | | -| **instrumentId** | **string** | The instrument_id of the saved card instrument which needs to be queried | | -| **xRequestId** | **string?** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | [optional] | -| **xIdempotencyKey** | **Guid?** | 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. | [optional] | - -### Return type - -[**CryptogramEntity**](CryptogramEntity.md) - -### Authorization - -[XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **400** | Bad request error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **401** | Authentication Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **404** | Resource Not found | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **409** | Resource already present | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **422** | Idempotency error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **429** | Rate Limit Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **500** | API related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| -| **502** | Bank related Error | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TransferDetails.md b/docs/TransferDetails.md deleted file mode 100644 index d1469bf..0000000 --- a/docs/TransferDetails.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.TransferDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vendor_id** | **string** | | [optional] -**transfer_from** | **string** | | [optional] -**transfer_type** | **string** | | [optional] -**transfer_amount** | **decimal** | | [optional] -**remark** | **string** | | [optional] -**tags** | [**List<TransferDetailsTagsInner>**](TransferDetailsTagsInner.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TransferDetailsTagsInner.md b/docs/TransferDetailsTagsInner.md deleted file mode 100644 index a6ac351..0000000 --- a/docs/TransferDetailsTagsInner.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.TransferDetailsTagsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**product** | **string** | | [optional] -**size** | **decimal** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UPIAuthorizeDetails.md b/docs/UPIAuthorizeDetails.md deleted file mode 100644 index 3486c70..0000000 --- a/docs/UPIAuthorizeDetails.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.UPIAuthorizeDetails -object when you are using preauth in UPI in order pay - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**approve_by** | **string** | Time by which this authorization should be approved by the customer. | [optional] -**start_time** | **string** | This is the time when the UPI one time mandate will start | [optional] -**end_time** | **string** | 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. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UPIPaymentMethod.md b/docs/UPIPaymentMethod.md deleted file mode 100644 index 20f394b..0000000 --- a/docs/UPIPaymentMethod.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.UPIPaymentMethod -Complete payment method for UPI collect - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**upi** | [**Upi**](Upi.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateTerminalEntity.md b/docs/UpdateTerminalEntity.md deleted file mode 100644 index 3fc4b3f..0000000 --- a/docs/UpdateTerminalEntity.md +++ /dev/null @@ -1,22 +0,0 @@ -# cashfree_pg.Model.UpdateTerminalEntity -Update terminal response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**added_on** | **string** | | [optional] -**cf_terminal_id** | **int** | | [optional] -**last_updated_on** | **string** | | [optional] -**terminal_address** | **string** | | [optional] -**terminal_email** | **string** | | [optional] -**terminal_type** | **string** | | [optional] -**teminal_id** | **string** | | [optional] -**terminal_name** | **string** | | [optional] -**terminal_note** | **string** | | [optional] -**terminal_phone_no** | **string** | | [optional] -**terminal_status** | **string** | | [optional] -**terminal_meta** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateTerminalRequest.md b/docs/UpdateTerminalRequest.md deleted file mode 100644 index 8e631d4..0000000 --- a/docs/UpdateTerminalRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.UpdateTerminalRequest -Request body to update terminal details. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminal_email** | **string** | Mention the updated email ID of the terminal. | [optional] -**terminal_phone_no** | **string** | Terminal phone number to be updated. | [optional] -**terminal_meta** | [**UpdateTerminalRequestTerminalMeta**](UpdateTerminalRequestTerminalMeta.md) | | [optional] -**terminal_type** | **string** | Mention the terminal type to be updated. Possible values - AGENT, STOREFRONT. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateTerminalRequestTerminalMeta.md b/docs/UpdateTerminalRequestTerminalMeta.md deleted file mode 100644 index d22cba3..0000000 --- a/docs/UpdateTerminalRequestTerminalMeta.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.UpdateTerminalRequestTerminalMeta -Terminal metadata. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminal_operator** | **string** | Name of the operator for the storefront. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateTerminalStatusRequest.md b/docs/UpdateTerminalStatusRequest.md deleted file mode 100644 index 75cea35..0000000 --- a/docs/UpdateTerminalStatusRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.UpdateTerminalStatusRequest -Request body to update terminal status. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminal_status** | **string** | Status of the terminal to be updated. possible values - ACTIVE, INACTIVE. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateVendorRequest.md b/docs/UpdateVendorRequest.md deleted file mode 100644 index 30fb5b6..0000000 --- a/docs/UpdateVendorRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# cashfree_pg.Model.UpdateVendorRequest -Update Vendor Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **string** | Specify the status of vendor that should be updated. Possible values: ACTIVE,BLOCKED, DELETED | -**name** | **string** | Specify the name of the vendor to be updated. Name should not have any special character except . / - & | -**email** | **string** | Specify the vendor email ID that should be updated. String in email ID format (Ex:johndoe_1@cashfree.com) should contain @ and dot (.) | -**phone** | **string** | Specify the beneficiaries phone number to be updated. Phone number registered in India (only digits, 8 - 12 characters after excluding +91). | -**verify_account** | **bool** | Specify if the vendor bank account details should be verified. Possible values: true or false | [optional] -**dashboard_access** | **bool** | Update if the vendor will have dashboard access or not. Possible values are: true or false | [optional] -**schedule_option** | **decimal** | 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** | [**List<BankDetails>**](BankDetails.md) | Specify the vendor bank account details to be updated. | [optional] -**upi** | [**List<UpiDetails>**](UpiDetails.md) | 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. | [optional] -**kyc_details** | [**List<KycDetails>**](KycDetails.md) | Specify the kyc details that should be updated. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateVendorResponse.md b/docs/UpdateVendorResponse.md deleted file mode 100644 index c6a7399..0000000 --- a/docs/UpdateVendorResponse.md +++ /dev/null @@ -1,27 +0,0 @@ -# cashfree_pg.Model.UpdateVendorResponse -Update Vendor Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **string** | | [optional] -**status** | **string** | | [optional] -**bank** | [**List<BankDetails>**](BankDetails.md) | | [optional] -**upi** | **string** | | [optional] -**added_on** | **string** | | [optional] -**updated_on** | **string** | | [optional] -**vendor_type** | **string** | | [optional] -**account_type** | **string** | | [optional] -**business_type** | **string** | | [optional] -**phone** | **decimal** | | [optional] -**name** | **string** | | [optional] -**vendor_id** | **string** | | [optional] -**schedule_option** | [**List<ScheduleOption>**](ScheduleOption.md) | | [optional] -**kyc_details** | [**List<KycDetails>**](KycDetails.md) | | [optional] -**dashboard_access** | **bool** | | [optional] -**bank_details** | **string** | | [optional] -**related_docs** | [**List<VendorEntityRelatedDocsInner>**](VendorEntityRelatedDocsInner.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Upi.md b/docs/Upi.md deleted file mode 100644 index c0adcb8..0000000 --- a/docs/Upi.md +++ /dev/null @@ -1,16 +0,0 @@ -# cashfree_pg.Model.Upi -UPI collect payment method object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**channel** | **string** | Specify the channel through which the payment must be processed. Can be one of [\"link\", \"collect\", \"qrcode\"] | -**upi_id** | **string** | Customer UPI VPA to process payment. ### Important This is a required parameter for channel = `collect` | [optional] -**upi_redirect_url** | **bool** | use this if you want cashfree to show a loader. Sample response below. It is only supported for collect `action:collect` will be returned with `data.url` having the link for redirection | [optional] -**upi_expiry_minutes** | **decimal** | 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 | [optional] -**authorize_only** | **bool** | For one time mandate on UPI. Set this as authorize_only = true. Please note that you can only use the \"collect\" channel if you are sending a one time mandate request | [optional] -**authorization** | [**UPIAuthorizeDetails**](UPIAuthorizeDetails.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpiDetails.md b/docs/UpiDetails.md deleted file mode 100644 index 9066c82..0000000 --- a/docs/UpiDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.UpiDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vpa** | **string** | | [optional] -**account_holder** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UploadTerminalDocs.md b/docs/UploadTerminalDocs.md deleted file mode 100644 index ee9e226..0000000 --- a/docs/UploadTerminalDocs.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.UploadTerminalDocs -Request body to upload terminal documents. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**doc_type** | **string** | Mention the document type you are uploading. Possible values - ADDRESSPROOF, PHOTOGRAPH. | -**doc_value** | **string** | Enter the display name of the uploaded file. | -**file** | **string** | 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. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UploadTerminalDocsEntity.md b/docs/UploadTerminalDocsEntity.md deleted file mode 100644 index d57863a..0000000 --- a/docs/UploadTerminalDocsEntity.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.UploadTerminalDocsEntity -Upload the terminal documents. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cf_terminal_id** | **int** | | [optional] -**doc_type** | **string** | | [optional] -**doc_value** | **string** | | [optional] -**status** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UploadVendorDocsRequest.md b/docs/UploadVendorDocsRequest.md deleted file mode 100644 index b9290a6..0000000 --- a/docs/UploadVendorDocsRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.UploadVendorDocsRequest -Update Vendor Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**doc_type** | **string** | Mention the type of the document you are uploading. Possible values: UIDAI_FRONT, UIDAI_BACK, UIDAI_NUMBER, DL, DL_NUMBER, PASSPORT_FRONT, PASSPORT_BACK, PASSPORT_NUMBER, VOTER_ID, VOTER_ID_NUMBER, PAN, PAN_NUMBER, GST, GSTIN_NUMBER, CIN, CIN_NUMBER, NBFC_CERTIFICATE. If the doc type ends with a number you should add the doc value else upload the doc file. | [optional] -**doc_value** | **System.IO.Stream** | Enter the display name of the uploaded file. | [optional] -**file** | **string** | 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. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UploadVendorDocumentsResponse.md b/docs/UploadVendorDocumentsResponse.md deleted file mode 100644 index 9f4d876..0000000 --- a/docs/UploadVendorDocumentsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.UploadVendorDocumentsResponse -Upload Vendor Document - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vendor_id** | **string** | | [optional] -**doc_type** | **string** | | [optional] -**doc_value** | **string** | | [optional] -**status** | **string** | | [optional] -**remarks** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/VendorBalance.md b/docs/VendorBalance.md deleted file mode 100644 index d22f86e..0000000 --- a/docs/VendorBalance.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.VendorBalance -Vendor Balance entity object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchant_id** | **decimal** | | [optional] -**vendor_id** | **string** | | [optional] -**merchant_unsettled** | **decimal** | | [optional] -**vendor_unsettled** | **decimal** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/VendorBalanceTransferCharges.md b/docs/VendorBalanceTransferCharges.md deleted file mode 100644 index 163275d..0000000 --- a/docs/VendorBalanceTransferCharges.md +++ /dev/null @@ -1,15 +0,0 @@ -# cashfree_pg.Model.VendorBalanceTransferCharges -Vendor Balance Transfer Charges entity object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**service_charges** | **decimal** | | [optional] -**service_tax** | **decimal** | | [optional] -**amount** | **decimal** | | [optional] -**billed_to** | **string** | | [optional] -**is_postpaid** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/VendorDocumentDownloadResponse.md b/docs/VendorDocumentDownloadResponse.md deleted file mode 100644 index 73b8634..0000000 --- a/docs/VendorDocumentDownloadResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.VendorDocumentDownloadResponse -Download Vendor Document - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**download_url** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/VendorDocumentsResponse.md b/docs/VendorDocumentsResponse.md deleted file mode 100644 index 5d2ede6..0000000 --- a/docs/VendorDocumentsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# cashfree_pg.Model.VendorDocumentsResponse -Get Vendor Documents - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**documents** | [**List<VendorEntityRelatedDocsInner>**](VendorEntityRelatedDocsInner.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/VendorEntity.md b/docs/VendorEntity.md deleted file mode 100644 index bf62f2f..0000000 --- a/docs/VendorEntity.md +++ /dev/null @@ -1,24 +0,0 @@ -# cashfree_pg.Model.VendorEntity -Vendor entity object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**email** | **string** | | [optional] -**status** | **string** | | [optional] -**phone** | **string** | | [optional] -**name** | **string** | | [optional] -**vendor_id** | **string** | | [optional] -**added_on** | **string** | | [optional] -**updated_on** | **string** | | [optional] -**bank** | [**List<BankDetails>**](BankDetails.md) | | [optional] -**upi** | **string** | | [optional] -**schedule_option** | [**List<ScheduleOption>**](ScheduleOption.md) | | [optional] -**vendor_type** | **string** | | [optional] -**account_type** | **string** | | [optional] -**business_type** | **string** | | [optional] -**related_docs** | [**List<VendorEntityRelatedDocsInner>**](VendorEntityRelatedDocsInner.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/VendorEntityRelatedDocsInner.md b/docs/VendorEntityRelatedDocsInner.md deleted file mode 100644 index 8aebd25..0000000 --- a/docs/VendorEntityRelatedDocsInner.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.VendorEntityRelatedDocsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vendor_id** | **string** | | [optional] -**doc_type** | **string** | | [optional] -**doc_value** | **string** | | [optional] -**status** | **string** | | [optional] -**remarks** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/VendorSplit.md b/docs/VendorSplit.md deleted file mode 100644 index 0f72ef1..0000000 --- a/docs/VendorSplit.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.VendorSplit -Use to split order when cashfree's Easy Split is enabled for your account. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**vendor_id** | **string** | Vendor id created in Cashfree system | -**amount** | **decimal** | Amount which will be associated with this vendor | [optional] -**percentage** | **decimal** | Percentage of order amount which shall get added to vendor account | [optional] -**tags** | **Dictionary<string, Object>** | Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/WHcustomerDetails.md b/docs/WHcustomerDetails.md deleted file mode 100644 index 038da98..0000000 --- a/docs/WHcustomerDetails.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.WHcustomerDetails -customer details object in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer_name** | **string** | | [optional] -**customer_id** | **string** | | [optional] -**customer_email** | **string** | | [optional] -**customer_phone** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/WHdata.md b/docs/WHdata.md deleted file mode 100644 index 892c6b7..0000000 --- a/docs/WHdata.md +++ /dev/null @@ -1,13 +0,0 @@ -# cashfree_pg.Model.WHdata -webhook object - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order** | [**WHorder**](WHorder.md) | | [optional] -**payment** | [**PaymentEntity**](PaymentEntity.md) | | [optional] -**customer_details** | [**WHcustomerDetails**](WHcustomerDetails.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/WHorder.md b/docs/WHorder.md deleted file mode 100644 index a2346ff..0000000 --- a/docs/WHorder.md +++ /dev/null @@ -1,14 +0,0 @@ -# cashfree_pg.Model.WHorder -order entity in webhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order_id** | **string** | | [optional] -**order_amount** | **double** | | [optional] -**order_currency** | **string** | | [optional] -**order_tags** | **Dictionary<string, string>** | Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/WalletOffer.md b/docs/WalletOffer.md deleted file mode 100644 index 8301198..0000000 --- a/docs/WalletOffer.md +++ /dev/null @@ -1,10 +0,0 @@ -# cashfree_pg.Model.WalletOffer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**provider** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - From a6a5c6e432db9c5c56f64feffc23ca04dde86a7a Mon Sep 17 00:00:00 2001 From: Venkatanaga Sudheer Kumar Date: Mon, 15 Apr 2024 06:47:51 +0530 Subject: [PATCH 2/3] PA-6913 docs --- docs/Eligibility.md | 380 +++++++++++++++++++++++++ docs/Offers.md | 2 +- docs/Orders.md | 2 +- docs/PaymentLink.md | 585 ++++++++++++++++++++++++++++++++++++++ docs/Payments.md | 665 ++++++++++++++++++++++++++++++++++++++++++++ docs/Refunds.md | 301 ++++++++++++++++++++ docs/Settlements.md | 2 +- docs/TokenValut.md | 354 +++++++++++++++++++++++ docs/Webhook.md | 75 +++++ 9 files changed, 2363 insertions(+), 3 deletions(-) create mode 100644 docs/Eligibility.md create mode 100644 docs/PaymentLink.md create mode 100644 docs/Payments.md create mode 100644 docs/Refunds.md create mode 100644 docs/TokenValut.md create mode 100644 docs/Webhook.md diff --git a/docs/Eligibility.md b/docs/Eligibility.md new file mode 100644 index 0000000..b4e550c --- /dev/null +++ b/docs/Eligibility.md @@ -0,0 +1,380 @@ +# Eligibility + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PGEligibilityFetchCardlessEMI**](Eligibility.md#PGEligibilityFetchCardlessEMI) | **Post** /eligibility/cardlessemi | Get Eligible Cardless EMI +[**PGEligibilityFetchOffers**](Eligibility.md#PGEligibilityFetchOffers) | **Post** /eligibility/offers | Get Eligible Offers +[**PGEligibilityFetchPaylater**](Eligibility.md#PGEligibilityFetchPaylater) | **Post** /eligibility/paylater | Get Eligible Paylater +[**PGEligibilityFetchPaymentMethods**](Eligibility.md#PGEligibilityFetchPaymentMethods) | **Post** /eligibility/payment_methods | Get Eligible Payment Methods + + + +## PGEligibilityFetchCardlessEMI + +> PGEligibilityFetchCardlessEMI(x_api_version: string, EligibilityFetchCardlessEMIRequest: EligibilityFetchCardlessEMIRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Eligible Cardless EMI ([Docs](https://docs.cashfree.com/reference/pgeligibilityfetchcardlessemi)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGEligibilityFetchCardlessEMIExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var eligibilityFetchCardlessEMIRequest = new EligibilityFetchCardlessEMIRequest{ + queries = { + amount = 10000, + customer_details= { + customer_phone = "7330797796" + } + } + }; // EligibilityFetchCardlessEMIRequest | Request Body to get eligible cardless emi options for a customer and order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Eligible Cardless EMI Payment Methods for a customer on an order + List response = cashfree.PGEligibilityFetchCardlessEMI(xApiVersion, eligibilityFetchCardlessEMIRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(response); + } + catch (ApiException e) + { + Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchCardlessEMI: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**eligibilityFetchCardlessEMIRequest** | [**EligibilityFetchCardlessEMIRequest***](Eligibility.md#EligibilityFetchCardlessEMIRequest) | Request Body to get eligible cardless emi options for a customer and order | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + +### Response + +```json +[ + { + "eligibility": true, + "entity_type": "cardlessemi", + "entity_value": "idfc", + "entity_details": { + "payment_method": "idfc", + "emi_plans": [ + { + "tenure": 1, + "interest_rate": 10, + "currency": "INR", + "emi": 400, + "total_interest": 10, + "total_amount": 40 + } + ] + } + } +] +``` + +## PGEligibilityFetchOffers + +> PGEligibilityFetchOffers(x_api_version: string, EligibilityFetchOffersRequest: EligibilityFetchOffersRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Eligible Offers ([Docs](https://docs.cashfree.com/reference/pgeligibilityfetchoffers)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGEligibilityFetchOffersExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var eligibilityFetchOffersRequest = new EligibilityFetchOffersRequest{ + queries = { + amount= 1 + } + }; // EligibilityFetchOffersRequest | Request Body to get eligible offers for a customer and order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Eligible Offers for an Order + List response = cashfree.PGEligibilityFetchOffers(xApiVersion, eligibilityFetchOffersRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(response); + } + catch (ApiException e) + { + Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchOffers: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**eligibilityFetchOffersRequest** | [**EligibilityFetchOffersRequest***](EligibilityFetchOffersRequest.md) | Request Body to get eligible offers for a customer and order | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + +### Response + +```json +[ + { + "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 + } + } +] +``` + + +## PGEligibilityFetchPaylater + +> PGEligibilityFetchPaylater(x_api_version: string, EligibilityFetchPaylaterRequest: EligibilityFetchPaylaterRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Eligible Paylater ([Docs](https://docs.cashfree.com/reference/pgeligibilityfetchpaylater)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGEligibilityFetchPaylaterExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var eligibilityFetchPaylaterRequest = new EligibilityFetchPaylaterRequest{ + queries = { + amount = 10000, + customer_details= { + customer_phone = "7330797796" + } + } + }; // EligibilityFetchPaylaterRequest | Request Body to get eligible paylater options for a customer and order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Eligible Paylater for a customer on an order + List response = cashfree.PGEligibilityFetchPaylater(xApiVersion, eligibilityFetchPaylaterRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(response); + } + catch (ApiException e) + { + Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchPaylater: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**eligibilityFetchPaylaterRequest** | [**EligibilityFetchPaylaterRequest***](EligibilityFetchPaylaterRequest.md) | Request Body to get eligible paylater options for a customer and order | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + +### Response + +```json +[ + { + "eligibility": true, + "entity_type": "paylater", + "entity_value": "olapostpaid", + "entity_details": { + "payment_method": "olapostpaid" + } + } +] +``` + + +## PGEligibilityFetchPaymentMethods + +> PGEligibilityFetchPaymentMethods(x_api_version: string, EligibilityFetchPaymentMethodsRequest: EligibilityFetchPaymentMethodsRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Eligible Payment Methods ([Docs](https://docs.cashfree.com/reference/pgeligibilityfetchpaymentmethods)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGEligibilityFetchPaymentMethodsExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var eligibilityFetchPaymentMethodsRequest = new EligibilityFetchPaymentMethodsRequest{ + queries = { + amount= 1000 + } + };// EligibilityFetchPaymentMethodsRequest | Request Body to get eligible payment methods for an account and order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get eligible Payment Methods + List result = cashfree.PGEligibilityFetchPaymentMethods(xApiVersion, eligibilityFetchPaymentMethodsRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling EligibilityApi.PGEligibilityFetchPaymentMethods: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**eligibilityFetchPaymentMethodsRequest** | [**EligibilityFetchPaymentMethodsRequest***](EligibilityFetchPaymentMethodsRequest.md) | Request Body to get eligible payment methods for an account and order | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + +### Response +```json +[ + { + "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 + } + ] + } + } +] +``` diff --git a/docs/Offers.md b/docs/Offers.md index cf1cd17..14d2e52 100644 --- a/docs/Offers.md +++ b/docs/Offers.md @@ -37,7 +37,7 @@ namespace Example var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - createOfferRequest = new CreateOfferRequest + var createOfferRequest = new CreateOfferRequest { offer_meta = new OfferMeta { diff --git a/docs/Orders.md b/docs/Orders.md index 8423348..9b78fc0 100644 --- a/docs/Orders.md +++ b/docs/Orders.md @@ -173,7 +173,7 @@ namespace Example var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order + var orderId = order_3242Tq4Edj9CC5RDcMeobmJOWOBJij; // string | The id which uniquely identifies your order var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) diff --git a/docs/PaymentLink.md b/docs/PaymentLink.md new file mode 100644 index 0000000..1a2215b --- /dev/null +++ b/docs/PaymentLink.md @@ -0,0 +1,585 @@ +# PaymentLinks + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PGCancelLink**](PaymentLink.md#PGCancelLink) | **Post** /links/{link_id}/cancel | Cancel Payment Link +[**PGCreateLink**](PaymentLink.md#PGCreateLink) | **Post** /links | Create Payment Link +[**PGFetchLink**](PaymentLink.md#PGFetchLink) | **Get** /links/{link_id} | Fetch Payment Link Details +[**PGLinkFetchOrders**](PaymentLink.md#PGLinkFetchOrders) | **Get** /links/{link_id}/orders | Get Orders for a Payment Link + + + +## PGCancelLink + +> PGCancelLink(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Cancel Payment Link ([Docs](https://docs.cashfree.com/reference/pgcancellink)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCancelLinkExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var linkId = your-link-id; // string | The payment link ID for which you want to view the details. + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Cancel Payment Link + LinkEntity result = cashfree.PGCancelLink(xApiVersion, linkId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentLinksApi.PGCancelLink: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**linkId** | **string** | The payment link ID for which you want to view the details. | +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response + +```json +{ + "cf_link_id": 1996567, + "link_id": "your_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": { + "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://b8af79f41056.eu.ngrok.io" + }, + "properties": { + "notify_url": { + "type": "string", + "description": "Notification URL for server-server communication. It should be an https URL." + }, + "upi_intent": { + "type": "boolean", + "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" + } + }, + "x-readme-ref-name": "LinkMetaEntity" + }, + "link_url": "https://payments-test.cashfree.com/links/o1tf1nvcvjhg", + "link_expiry_time": "2021-10-14T15:04:05+05:30", + "link_notes": { + "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" + }, + "x-readme-ref-name": "LinkNotesEntity" + }, + "link_auto_reminders": true, + "link_notify": { + "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" + } + }, + "x-readme-ref-name": "LinkNotifyEntity" + } +} +``` + + +## PGCreateLink + +> PGCreateLink(x_api_version: string, CreateLinkRequest: CreateLinkRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Create Payment Link ([Docs](https://docs.cashfree.com/reference/pgcreatelink)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCreateLinkExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var createLinkRequest = new CreateLinkRequest{ + link_amount = 100, + link_currency = "INR", + link_minimum_partial_amount = 20, + link_id = "my_link_id", + link_partial_payments = true, + customer_details = new CustomerDetails + { + customer_name = "John Doe", + customer_phone = "9999999999", + customer_email = "john@cashfree.com" + }, + link_expiry_time = "2024-10-14T15:04:05+05:30", + link_purpose = "Payment for PlayStation 11", + link_notify = new LinkNotify + { + send_sms = false, + send_email = true + }, + link_auto_reminders = false, + link_notes = new LinkNotes + { + key_1 = "value_1", + key_2 = "value_2" + }, + link_meta = new LinkMeta + { + notify_url = "https://ee08e626ecd88c61c85f5c69c0418cb5.m.pipedream.net", + upi_intent = false, + return_url = "https://b8af79f41056.eu.ngrok.io" + } + }; // CreateLinkRequest | Request Body to Create Payment Links + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Create Payment Link + LinkEntity result = cashfree.PGCreateLink(xApiVersion, createLinkRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentLinksApi.PGCreateLink: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**createLinkRequest** | **CreateLinkRequest*** | Request Body to Create Payment Links | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response + +```json +{ + "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": { + "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://b8af79f41056.eu.ngrok.io" + }, + "properties": { + "notify_url": { + "type": "string", + "description": "Notification URL for server-server communication. It should be an https URL." + }, + "upi_intent": { + "type": "boolean", + "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" + } + }, + "x-readme-ref-name": "LinkMetaEntity" + }, + "link_url": "https://payments-test.cashfree.com/links/o1tf1nvcvjhg", + "link_expiry_time": "2021-10-14T15:04:05+05:30", + "link_notes": { + "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" + }, + "x-readme-ref-name": "LinkNotesEntity" + }, + "link_auto_reminders": true, + "link_notify": { + "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" + } + }, + "x-readme-ref-name": "LinkNotifyEntity" + } +} +``` + + +## PGFetchLink + +> PGFetchLink(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Fetch Payment Link Details ([Docs](https://docs.cashfree.com/reference/pgfetchlink)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGFetchLinkExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var linkId = my_link_id_test; // string | The payment link ID for which you want to view the details. + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Fetch Payment Link Details + LinkEntity result = cashfree.PGFetchLink(xApiVersion, linkId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentLinksApi.PGFetchLink: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**linkId** | **string*** | The payment link ID for which you want to view the details. | +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +{ + "cf_link_id": 1996567, + "link_id": "my_link_id_test", + "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": { + "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://b8af79f41056.eu.ngrok.io" + }, + "properties": { + "notify_url": { + "type": "string", + "description": "Notification URL for server-server communication. It should be an https URL." + }, + "upi_intent": { + "type": "boolean", + "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" + } + }, + "x-readme-ref-name": "LinkMetaEntity" + }, + "link_url": "https://payments-test.cashfree.com/links/o1tf1nvcvjhg", + "link_expiry_time": "2021-10-14T15:04:05+05:30", + "link_notes": { + "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" + }, + "x-readme-ref-name": "LinkNotesEntity" + }, + "link_auto_reminders": true, + "link_notify": { + "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" + } + }, + "x-readme-ref-name": "LinkNotifyEntity" + } +} +``` + + +## PGLinkFetchOrders + +> PGLinkFetchOrders(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Orders for a Payment Link ([Docs](https://docs.cashfree.com/reference/pglinkfetchorders)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGLinkFetchOrdersExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var linkId = your-link-id; // string | The payment link ID for which you want to view the details. + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Orders for a Payment Link + List result = cashfree.PGLinkFetchOrders(xApiVersion, linkId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentLinksApi.PGLinkFetchOrders: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**linkId** | **string*** | The payment link ID for which you want to view the details. | +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +[ + { + "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" + }, + "entity": "order", + "order_amount": 22, + "order_currency": "INR", + "order_expiry_time": "2023-09-09T18:02:46+05:30", + "order_id": "order_3242Tq4Edj9CC5RDcMeobmJOWOBJij", + "order_meta": { + "return_url": "https://example.com/return/{order_id}", + "notify_url": "https://example.com/notify", + "payment_methods": "cc" + }, + "order_note": "some order note LIST", + "order_splits": [], + "order_status": "ACTIVE", + "order_tags": { + "name": "John", + "age": "19" + }, + "payment_session_id": "session_a1VXIPJo8kh7IBigVXX8LgTMupQW_cu25FS8KwLwQLOmiHqbBxq5UhEilrhbDSKKHA6UAuOj9506aaHNlFAHEqYrHSEl9AVtYQN9LIIc4vkH", + "payments": { + "url": "https://sandbox.cashfree.com/pg/orders/order_3242Tq4Edj9CC5RDcMeobmJOWOBJij/payments" + }, + "refunds": { + "url": "https://sandbox.cashfree.com/pg/orders/order_3242Tq4Edj9CC5RDcMeobmJOWOBJij/refunds" + }, + "settlements": { + "url": "https://sandbox.cashfree.com/pg/orders/order_3242Tq4Edj9CC5RDcMeobmJOWOBJij/settlements" + }, + "terminal_data": null + } +] +``` diff --git a/docs/Payments.md b/docs/Payments.md new file mode 100644 index 0000000..2734927 --- /dev/null +++ b/docs/Payments.md @@ -0,0 +1,665 @@ +# Payments + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PGOrderFetchPayment**](Payments.md#PGOrderFetchPayment) | **Get** /orders/{order_id}/payments/{cf_payment_id} | Get Payment by ID +[**PGOrderFetchPayments**](Payments.md#PGOrderFetchPayments) | **Get** /orders/{order_id}/payments | Get Payments for an Order +[**PGPayOrder**](Payments.md#PGPayOrder) | **Post** /orders/sessions | Order Pay +[**PGAuthorizeOrder**](Payments.md#PGAuthorizeOrder) | **Post** /orders/{order_id}/authorization | Preauthorization +[**PGOrderAuthenticatePayment**](Payments.md#PGOrderAuthenticatePayment) | **Post** /orders/pay/authenticate/{cf_payment_id} | Submit or Resend OTP + + +## PGOrderFetchPayment + +> PGOrderFetchPayment(x_api_version: string, order_id: string, cf_payment_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Payment by ID ([Docs](https://docs.cashfree.com/reference/pgorderfetchpayment)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGOrderFetchPaymentExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = your-order-id; // string | The id which uniquely identifies your order + var cfPaymentId = 121224562; // string | The Cashfree payment or transaction ID. + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Payment by ID + PaymentEntity response= cashfree.PGOrderFetchPayment(xApiVersion, orderId, cfPaymentId, xRequestId, xIdempotencyKey); + Debug.WriteLine(response); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentsApi.PGOrderFetchPayment: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**orderId** | **string*** | The id which uniquely identifies your order | +**cfPaymentId** | **string*** | The Cashfree payment or transaction ID. | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +{ + "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" + } + }, + "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" +} +``` + + + +## PGOrderFetchPayments + +> PGOrderFetchPayments(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Payments for an Order ([Docs](https://docs.cashfree.com/reference/pgorderfetchpayments)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGOrderFetchPaymentsExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = your-order-id; // string | The id which uniquely identifies your order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Payments for an Order + List result = cashfree.PGOrderFetchPayments(xApiVersion, orderId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentsApi.PGOrderFetchPayments: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**orderId** | **string*** | The id which uniquely identifies your order | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +[ + { + "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" + } + }, + "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" + }, + { + "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" + } +] +``` + +## PGPayOrder + +> PGPayOrder(x_api_version: string, PayOrderRequest: PayOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Order Pay ([Docs](https://docs.cashfree.com/reference/pgpayorder)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGPayOrderExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var payOrderRequest = new PayOrderRequest{ + payment_session_id = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + payment_method = new PaymentMethod{ + card = new Card + { + channel = "link", + card_holder_name = "Test", + card_number = "4111111111111111", + card_expiry_mm = "12", + card_expiry_yy = "30", + card_cvv = "123" + } + } + }; // PayOrderRequest | Request body to create a transaction at cashfree using `payment_session_id` + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Order Pay + PayOrderEntity result = cashfree.PGPayOrder(xApiVersion, payOrderRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentsApi.PGPayOrder: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **payOrderRequest** | **PayOrderRequest*** | Request body to create a transaction at cashfree using `payment_session_id` | + **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] + **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +#### Netbanking +```csharp +var payOrderRequest = new PayOrderRequest +{ + payment_session_id = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + payment_method = new PaymentMethod + { + netbanking = new Netbanking + { + channel = "link", + netbanking_bank_code = 3021 + } + } +} +``` + +#### UPI +```csharp +var payOrderRequest = new PayOrderRequest +{ + payment_session_id = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + payment_method = new PaymentMethod + { + upi = new Upi + { + channel = "collect", + upi_id = "testsuccess@gocash" + } + } +} +``` + +#### UPI +```csharp +var payOrderRequest = new PayOrderRequest +{ + payment_session_id = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + payment_method = new PaymentMethod + { + upi = new Upi + { + channel = "link" + } + } +} +``` + +#### QR +```csharp +var payOrderRequest = new PayOrderRequest +{ + payment_session_id = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + payment_method = new PaymentMethod + { + upi = new Upi + { + channel = "qrcode" + } + } +} +``` + +#### Wallet +```csharp +var payOrderRequest = new PayOrderRequest +{ + payment_session_id = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + payment_method = new PaymentMethod + { + app = new App + { + provider = "phonepe", + channel = "link", + phone = "8474090589" + } + } +} +``` + +#### Card (with saving it) +```csharp +var payOrderRequest = new PayOrderRequest +{ + payment_session_id = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + payment_method = new PaymentMethod + { + card = new Card + { + channel = "link", + card_holder_name = "Test", + card_number = "4111111111111111", + card_expiry_mm = "12", + card_expiry_yy = "30", + card_cvv = "123" + } + }, + save_instrument = true +} +``` + +#### Card with saved instrument +```csharp +var payOrderRequest = new PayOrderRequest +{ + PaymentSessionId = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + PaymentMethod = new PaymentMethod + { + Card = new Card + { + Channel = "link", + InstrumentId = "54deabb4-ba45-4a60-9e6a-9c016fe7ab10", + CardCvv = "900" + } + } +} +``` + +#### Card (with native otp) +```csharp +var payOrderRequest = new PayOrderRequest +{ + PaymentSessionId = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + PaymentMethod = new PaymentMethod + { + Card = new Card + { + Channel = "post", + CardNumber = "4111111111111111", + CardExpiryMm = "03", + CardExpiryYy = "25", + CardCvv = "326" + } + } +} +``` + +#### EMI +```csharp +var payOrderRequest = new PayOrderRequest +{ + PaymentSessionId = "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", + PaymentMethod = new PaymentMethod + { + Emi = new Emi + { + Channel = "link", + CardNumber = "4748461111111111", + CardExpiryMm = "12", + CardExpiryYy = "24", + CardCvv = "123", + CardBankName = "ICICI", + EmiTenure = 3 + } + } +} +``` + +### Response +```json +{ + "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" + } +} +``` + +## PGAuthorizeOrder + +> PGAuthorizeOrder(x_api_version: string, order_id: string, AuthorizeOrderRequest: AuthorizeOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Preauthorization ([Docs](https://docs.cashfree.com/reference/pgauthorizeorder)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGAuthorizeOrderExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = your-order-id; // string | The id which uniquely identifies your order + var authorizeOrderRequest = new AuthorizeOrderRequest{ + action = "CAPTURE", // or VOID + amount = 1 + }; // AuthorizeOrderRequest | Request to Capture or Void Transactions + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Preauthorization + PaymentEntity response = cashfree.PGAuthorizeOrder(xApiVersion, orderId, authorizeOrderRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(response); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentsApi.PGAuthorizeOrder: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **string*** | The id which uniquely identifies your order | + **authorizeOrderRequest** | **AuthorizeOrderRequest*** | Request to Capture or Void Transactions | + **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] + **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +{ + "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" + } + }, + "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" +} +``` + + +## PGOrderAuthenticatePayment + +> PGOrderAuthenticatePayment(x_api_version: string, cf_payment_id: string, OrderAuthenticatePaymentRequest: OrderAuthenticatePaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Submit or Resend OTP ([Docs](https://docs.cashfree.com/reference/pgorderauthenticatepayment)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGOrderAuthenticatePaymentExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var cfPaymentId = 121224562; // string | The Cashfree payment or transaction ID. + var orderAuthenticatePaymentRequest = new OrderAuthenticatePaymentRequest{ + otp = "111000", + action = "SUBMIT_OTP" + }; // OrderAuthenticatePaymentRequest | Request body to submit/resend headless OTP. To use this API make sure you have headless OTP enabled for your account + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Submit or Resend OTP + OrderAuthenticateEntity result = cashfree.PGOrderAuthenticatePayment(xApiVersion, cfPaymentId, orderAuthenticatePaymentRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PaymentsApi.PGOrderAuthenticatePayment: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**cfPaymentId** | **string*** | The Cashfree payment or transaction ID. | +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**orderAuthenticatePaymentRequest** | **OrderAuthenticatePaymentRequest*** | Request body to submit/resend headless OTP. To use this API make sure you have headless OTP enabled for your account | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +{ + "cf_payment_id": 975654863, + "authenticate_status": "FAILED", + "action": "SUBMIT_OTP", + "payment_message": "otp is invalid" +} +``` diff --git a/docs/Refunds.md b/docs/Refunds.md new file mode 100644 index 0000000..606b37a --- /dev/null +++ b/docs/Refunds.md @@ -0,0 +1,301 @@ +# Refunds + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PGOrderCreateRefund**](Refunds.md#PGOrderCreateRefund) | **Post** /orders/{order_id}/refunds | Create Refund +[**PGOrderFetchRefund**](Refunds.md#PGOrderFetchRefund) | **Get** /orders/{order_id}/refunds/{refund_id} | Get Refund +[**PGOrderFetchRefunds**](Refunds.md#PGOrderFetchRefunds) | **Get** /orders/{order_id}/refunds | Get All Refunds for an Order + +## PGOrderCreateRefund + +> PGOrderCreateRefund(x_api_version: string, order_id: string, OrderCreateRefundRequest: OrderCreateRefundRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Create Refund ([Docs](https://docs.cashfree.com/reference/pgordercreaterefund)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGOrderCreateRefundExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = your-order-id; // string | The id which uniquely identifies your order + var orderCreateRefundRequest = new OrderCreateRefundRequest{ + refund_id = "refund_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8", + refund_amount = 1 + }; // OrderCreateRefundRequest | Request Body to Create Refunds + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Create Refund + RefundEntity result = cashfree.PGOrderCreateRefund(xApiVersion, orderId, orderCreateRefundRequest, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling RefundsApi.PGOrderCreateRefund: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**orderId** | **string*** | The id which uniquely identifies your order | + **xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] + **orderCreateRefundRequest** | [**OrderCreateRefundRequest***](Refunds.md#OrderCreateRefundRequest) | Request Body to Create Refunds | + **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +#### OrderCreateRefundRequest +Name | Type | Description | Example +------------- | ------------- | ------------- | ------------- +**refund_amount** | **double*** | Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed) | 1.0 +**refund_id** | **string*** | An unique ID to associate the refund with. Provie alphanumeric values | refund_id_1888 +**refund_note** | **string** | A refund note for your reference. | Initiating a refund from Node SDK +**refund_speed** | **string** | Speed at which the refund is processed. It's an optional field with default being STANDARD | STANDARD or INSTANT +**refund_splits** | **object[]** | If at all the refund has to be split between multiple vendors + +#### RefundSplits +Name | Type | Description | Example +------------- | ------------- | ------------- | ------------- +**vendor_id** | **string** | Vendor id created in Cashfree system | vendor_01 +**amount** | **double** | Amount which will be associated with this vendor | 1.0 +**percentage** | **double** | Percentage of order amount which shall get added to vendor account | 25 + +### Response + +```json +{ + "cf_payment_id": 2388816360, + "cf_refund_id": "refund_40564529", + "created_at": "2024-01-11T16:58:06+05:30", + "entity": "refund", + "metadata": null, + "order_id": "order_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8", + "processed_at": null, + "refund_amount": 1, + "refund_arn": null, + "refund_charge": 0, + "refund_currency": "INR", + "refund_id": "refund_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8", + "refund_mode": null, + "refund_note": null, + "refund_speed": { + "requested": "STANDARD", + "accepted": "STANDARD", + "processed": null, + "message": null + }, + "refund_splits": [], + "refund_status": "PENDING", + "refund_type": "MERCHANT_INITIATED", + "status_description": "In Progress" +} +``` + +## PGOrderFetchRefund + +> PGOrderFetchRefund(x_api_version: string, order_id: string, refund_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get Refund ([Docs](https://docs.cashfree.com/reference/pgorderfetchrefund)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGOrderFetchRefundExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = order_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8; // string | The id which uniquely identifies your order + var refundId = refund_40564529; // string | Refund Id of the refund you want to fetch. + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get Refund + RefundEntity result = cashfree.PGOrderFetchRefund(xApiVersion, orderId, refundId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling RefundsApi.PGOrderFetchRefund: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**orderId** | **string** | The id which uniquely identifies your order | +**refundId** | **string** | Refund Id of the refund you want to fetch. | +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +{ + "cf_payment_id": 2388816360, + "cf_refund_id": "refund_40564529", + "created_at": "2024-01-11T16:58:06+05:30", + "entity": "refund", + "metadata": null, + "order_id": "order_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8", + "processed_at": null, + "refund_amount": 1, + "refund_arn": null, + "refund_charge": 0, + "refund_currency": "INR", + "refund_id": "refund_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8", + "refund_mode": null, + "refund_note": null, + "refund_speed": { + "requested": "STANDARD", + "accepted": "STANDARD", + "processed": null, + "message": null + }, + "refund_splits": [], + "refund_status": "PENDING", + "refund_type": "MERCHANT_INITIATED", + "status_description": "In Progress" +} +``` + +## PGOrderFetchRefunds + +> PGOrderFetchRefunds(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Get All Refunds for an Order ([Docs](https://docs.cashfree.com/reference/pgorderfetchrefunds)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGOrderFetchRefundsExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var orderId = order_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8; // string | The id which uniquely identifies your order + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Get All Refunds for an Order + List result = cashfree.PGOrderFetchRefunds(xApiVersion, orderId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling RefundsApi.PGOrderFetchRefunds: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**orderId** | **string** | The id which uniquely identifies your order | +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +[ + { + "cf_payment_id": 2388816360, + "cf_refund_id": "refund_40564529", + "created_at": "2024-01-11T16:58:06+05:30", + "entity": "refund", + "metadata": null, + "order_id": "order_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8", + "processed_at": null, + "refund_amount": 1, + "refund_arn": null, + "refund_charge": 0, + "refund_currency": "INR", + "refund_id": "refund_145082ao5HaUJOvfXKfdQwZ3A1jy5Pq8", + "refund_mode": null, + "refund_note": null, + "refund_speed": { + "requested": "STANDARD", + "accepted": "STANDARD", + "processed": null, + "message": null + }, + "refund_splits": [], + "refund_status": "PENDING", + "refund_type": "MERCHANT_INITIATED", + "status_description": "In Progress" +} +] +``` diff --git a/docs/Settlements.md b/docs/Settlements.md index 9cdd655..c97f09e 100644 --- a/docs/Settlements.md +++ b/docs/Settlements.md @@ -35,7 +35,7 @@ namespace Example var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") - var orderId = your-order-id; // string | The id which uniquely identifies your order + var orderId = order-12-127; // string | The id which uniquely identifies your order var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) diff --git a/docs/TokenValut.md b/docs/TokenValut.md new file mode 100644 index 0000000..7138e2e --- /dev/null +++ b/docs/TokenValut.md @@ -0,0 +1,354 @@ +# TokenVault + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PGCustomerDeleteInstrument**](TokenVault.md#PGCustomerDeleteInstrument) | **Delete** /customers/{customer_id}/instruments/{instrument_id} | Delete Saved Card Instrument +[**PGCustomerFetchInstrument**](TokenVault.md#PGCustomerFetchInstrument) | **Get** /customers/{customer_id}/instruments/{instrument_id} | Fetch Specific Saved Card Instrument +[**PGCustomerFetchInstruments**](TokenVault.md#PGCustomerFetchInstruments) | **Get** /customers/{customer_id}/instruments | Fetch All Saved Card Instrument +[**PGCustomerInstrumentsFetchCryptogram**](TokenVault.md#PGCustomerInstrumentsFetchCryptogram) | **Get** /customers/{customer_id}/instruments/{instrument_id}/cryptogram | Fetch cryptogram for a saved card instrument + + + +## PGCustomerDeleteInstrument + +> PGCustomerDeleteInstrument(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Delete Saved Card Instrument ([Docs](https://docs.cashfree.com/reference/pgcustomerdeleteinstrument)) + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCustomerDeleteInstrumentExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var customerId = siddhesh_desai; // string | Your Customer ID that you had sent during create order API `POST/orders` + var instrumentId = 54deabb4-ba45-4a60-9e6a-9c016fe7ab10; // string | The instrument_id which needs to be deleted + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Delete Saved Card Instrument + InstrumentEntity result = cashfree.PGCustomerDeleteInstrument(xApiVersion, customerId, instrumentId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TokenVaultApi.PGCustomerDeleteInstrument: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**customerId** | **string*** | Your Customer ID that you had sent during create order API `POST/orders` | +**instrumentId** | **string*** | The instrument_id which needs to be deleted | +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response + +```json +{ + "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" + } + } +} +``` + +## PGCustomerFetchInstrument + +> PGCustomerFetchInstrument(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Fetch Specific Saved Card Instrument ([Docs](https://docs.cashfree.com/reference/pgcustomerfetchinstrument)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCustomerFetchInstrumentExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var customerId = siddhesh_desai; // string | Your Customer ID that you had sent during create order API `POST/orders` + var instrumentId = 54deabb4-ba45-4a60-9e6a-9c016fe7ab10; // string | The instrument_id of the saved instrument which needs to be queried + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Fetch Specific Saved Card Instrument + InstrumentEntity result = cashfree.PGCustomerFetchInstrument(xApiVersion, customerId, instrumentId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TokenVaultApi.PGCustomerFetchInstrument: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**customerId** | **string** | Your Customer ID that you had sent during create order API `POST/orders` | +**instrumentId** | **string** | The instrument_id of the saved instrument which needs to be queried | +**xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +{ + "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" + } + } +} +``` + +## PGCustomerFetchInstruments + +> PGCustomerFetchInstruments(x_api_version: string, customer_id: string, instrument_type: PGCustomerFetchInstrumentsInstrumentTypeEnum, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Fetch All Saved Card Instrument ([Docs](https://docs.cashfree.com/reference/pgcustomerfetchinstruments)) + +### Example + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCustomerFetchInstrumentsExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var customerId = siddhesh_desai; // string | Your Customer ID that you had sent during create order API `POST/orders` + var instrumentType = card; // string | Payment mode or type of saved instrument + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Fetch All Saved Card Instrument + List result = cashfree.PGCustomerFetchInstruments(xApiVersion, customerId, instrumentType, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TokenVaultApi.PGCustomerFetchInstruments: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**customerId** | **string*** | Your Customer ID that you had sent during create order API `POST/orders` | +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**instrumentType** | **string*** | Payment mode or type of saved instrument | +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response +```json +[ + { + "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" + } + } +} +] +``` + + +## PGCustomerInstrumentsFetchCryptogram + +> PGCustomerInstrumentsFetchCryptogram(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> + +Fetch cryptogram for a saved card instrument ([Docs](https://docs.cashfree.com/reference/pgcustomerinstrumentsfetchcryptogram)) + + + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using cashfree_pg.Client; +using cashfree_pg.Model; + +namespace Example +{ + public class PGCustomerInstrumentsFetchCryptogramExample + { + public static void Main() + { + // Configuration + Cashfree.XClientId = ""; + Cashfree.XClientSecret = ""; + Cashfree.XEnvironment = Cashfree.SANDBOX; + + // Instance of Cashfree + var cashfree = new Cashfree(); + + + var xApiVersion = 2023-08-01; // string | API version to be used. Format is in YYYY-MM-DD (default to "2023-08-01") + var customerId = siddhesh_desai; // string | Your Customer ID that you had sent during create order API `POST/orders` + var instrumentId = 54deabb4-ba45-4a60-9e6a-9c016fe7ab10; // string | The instrument_id of the saved card instrument which needs to be queried + var xRequestId = 4dfb9780-46fe-11ee-be56-0242ac120002; // string? | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree (optional) + var xIdempotencyKey = 47bf8872-46fe-11ee-be56-0242ac120002; // Guid? | 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. (optional) + + try + { + // Fetch cryptogram for a saved card instrument + CryptogramEntity result = cashfree.PGCustomerInstrumentsFetchCryptogram(xApiVersion, customerId, instrumentId, xRequestId, xIdempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TokenVaultApi.PGCustomerInstrumentsFetchCryptogram: " + e.Message); + Debug.Print("Status Code: " + e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**customerId** | **string*** | Your Customer ID that you had sent during create order API `POST/orders` | +**instrumentId** | **string*** | The instrument_id of the saved card instrument which needs to be queried | +**xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] +**xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | + + +### Response + +```json +{ + "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" +} +``` diff --git a/docs/Webhook.md b/docs/Webhook.md new file mode 100644 index 0000000..246d92b --- /dev/null +++ b/docs/Webhook.md @@ -0,0 +1,75 @@ +# Webhook + + +## PGVerifyWebhookSignature + +> PGVerifyWebhookSignature(signature: string, rawBody: string, timestamp: string): PGWebhookEvent + +Verify Webhook Signatures ([Docs](https://docs.cashfree.com/reference/pg-webhook) + +### Example + +```csharp +using Microsoft.AspNetCore.Mvc; +using System; +using System.IO; +using System.Threading.Tasks; + +[ApiController] + [Route("[controller]")] +public class WebhookController : ControllerBase +{ + [HttpPost] + public async Task HandleWebhook() + { + try + { + string signature = Request.Headers["x-webhook-signature"]; + string timestamp = Request.Headers["x-webhook-timestamp"]; + string requestBody; + + using (StreamReader reader = new StreamReader(Request.Body)) + { + requestBody = await reader.ReadToEndAsync(); + } + + var response = Cashfree.PGVerifyWebhookSignature(signature, requestBody, timestamp); + Console.WriteLine(response.Object); // This is where you handle the verified webhook payload + } + catch (Exception ex) + { + Console.WriteLine(ex.Message); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**signature** | **string** | The "x-webhook-signature" present in the headers received | +**rawBody** | **string** | The request body received in the request in string format | +**timestamp** | **string** | The "x-webhook-timestamp" present in the headers received | + + +### Response + +```json +{ + "type": "PAYMENT_SUCCESS_WEBHOOK", + "rawBody":"{\"type\":\"PAYMENT_SUCCESS_WEBHOOK\",\"data\":{}}", + "object": { + "type": "PAYMENT_SUCCESS_WEBHOOK", + "data": { + + } + } +} +``` + +`Note:` The `object` in the response is returned as a JSON object. But it can be any of the following types: +- [Payment Webhook](https://docs.cashfree.com/docs/payment-webhooks) +- [Refund Webhook](https://docs.cashfree.com/docs/refunds-webhook) +- [Settlement Webhook](https://docs.cashfree.com/docs/settlements-webhook) +- [Instrument Webhook](https://docs.cashfree.com/docs/instrument-webhook) From 64a37867f916c6f7200f0affe28c708c1aa1e1be Mon Sep 17 00:00:00 2001 From: Venkatanaga Sudheer Kumar Date: Mon, 15 Apr 2024 15:05:47 +0530 Subject: [PATCH 3/3] PA-6913 docs --- README.md | 24 ++++++++++++++++++++++-- docs/{TokenValut.md => TokenVault.md} | 0 2 files changed, 22 insertions(+), 2 deletions(-) rename docs/{TokenValut.md => TokenVault.md} (100%) diff --git a/README.md b/README.md index 5bb2aea..263fc3e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Cashfree PG .Net SDK ![GitHub](https://img.shields.io/github/license/cashfree/cashfree-pg-sdk-dotnet) ![Discord](https://img.shields.io/discord/931125665669972018?label=discord) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/cashfree/cashfree-pg-sdk-dotnet/master) ![GitHub release (with filter)](https://img.shields.io/github/v/release/cashfree/cashfree-pg-sdk-dotnet?label=latest) ![GitHub forks](https://img.shields.io/github/forks/cashfree/cashfree-pg-sdk-go) -The Cashfree PG .Net SDK offers a convenient solution to access [Cashfree PG APIs](https://docs.cashfree.com/reference/pg-new-apis-endpoint) from a server-side .Net applications. +The Cashfree PG .Net SDK offers a convenient solution to access [Cashfree PG APIs](https://docs.cashfree.com/reference/pg-new-apis-endpoint) from a server-side .Net applications. @@ -32,6 +32,7 @@ var cashfree = new Cashfree(); var xApiVersion = "2022-09-01"; ``` + Generate your API keys (x-client-id , x-client-secret) from [Cashfree Merchant Dashboard](https://merchant.cashfree.com/merchants/login) ### Basic Usage @@ -51,7 +52,6 @@ try { Console.WriteLine(e.StackTrace); } ``` - Get Order ```csharp try { @@ -66,6 +66,26 @@ try { } ``` +## Supported Resources + +- [Order](docs/Orders.md) + +- [Payment](docs/Payments.md) + +- [Refund](docs/Refunds.md) + +- [Token Vault](docs/TokenVault.md) + +- [Eligiblity](docs/Eligibility.md) + +- [PaymentLink](docs/PaymentLink.md) + +- [Settlements](docs/Settlements.md) + +- [Offers](docs/Offers.md) + +- [Reconciliation](docs/Reconciliation.md) + ## Licence Apache Licensed. See [LICENSE.md](LICENSE.md) for more details \ No newline at end of file diff --git a/docs/TokenValut.md b/docs/TokenVault.md similarity index 100% rename from docs/TokenValut.md rename to docs/TokenVault.md