JUMP TOCashfree Payment Gateway APIsEnd PointsServer SDKsRelease Notes: V4 (2023-08-01)OrdersCreate OrderpostGet OrdergetTerminate OrderpatchGet Order ExtendedgetUpdate Order ExtendedputPaymentsSubmit or Resend OTPpostOrder PaypostPreauthorizationpostGet Payments for an OrdergetGet Payment by IDgetRefundsCreate RefundpostGet All Refunds for an OrdergetGet RefundgetSettlementsGet Settlements by Order IDgetPayment LinksCreate Payment LinkpostFetch Payment Link DetailsgetCancel Payment LinkpostGet Orders for a Payment LinkgetToken VaultFetch All Saved Card InstrumentgetFetch Specific Saved Card InstrumentgetDelete Saved Card InstrumentdeleteFetch cryptogram for a saved card instrumentgetsoftPOSCreate TerminalpostCreate Terminal TransactionpostFetch Terminal QR CodesgetOnboard Soundbox VpapostUpdate Soundbox VpapatchDemap Soundbox VpapostUpload Terminal DocspostsoftPOS WebhooksFetch Terminal Soundbox vpagetGet Terminal TransactiongetUpdate TerminalpatchUpdate Terminal StatuspatchGet Terminal Status using Phone NumbergetOffersCreate OfferpostGet Offer by IDgetEligibilityGet Eligible Cardless EMI Payment Methods for a customer on an orderpostGet Eligible Offers for an OrderpostGet Eligible Paylater for a customer on an orderpostGet eligible Payment MethodspostSettlement ReconciliationSettlement ReconciliationpostSettlement ReconciliationpostGet All SettlementspostPG ReconciliationPG ReconciliationpostCustomersCreate Customer at CashfreepostEasy-SplitGet Vendor All DetailsgetUpdate vendor DetailspatchCreate vendorpostGet Vendor All Documents StatusgetUpload Vendor DocspostDownload Vendor DocumentsgetGet On Demand BalancegetGet Vendor Balance Transfer ChargesgetCreate On Demand TransferpostSplit After PaymentpostCreate Static Split ConfigurationpostCreate AdjustmentpostGet Split and Settlement Details by OrderIDgetGet Split and Settlement Details by OrderID v2.0postDisputesGet Disputes by Order IDgetGet Disputes by Dispute IDgetGet Disputes by Payment IDgetAccept DisputeputContest Dispute by Submitting EvidencepostGet Submitted Evidences by Document IDgetSimulationSimulate PaymentpostFetch SimulationgetDisputesSubmit Evidence to contest the Dispute by Dispute IDpostGet Disputes by Order IdgetGet Disputes by Payment IDgetGet Disputes by Dispute IDgetAccept Dispute by Dispute IDput/partners/merchant/qrcodesCreate Pre-Activated Vpas for partnerpostGet Pre-Activated Vpas for partnergetSubscriptionFetch SubscriptiongetCreate SubscriptionpostManage a subscription.postFetch PlangetCreate a plan.postFetch details of all payments of a subscription.getFetch details of a single payment.getManage a single payment.postFetch details of a refund.getCreate a refund.postRaise a charge or create an auth.postAPI to upload file for Physical Nach Authorization.postAPI to get all the payment method details available for subscription payments.postWebhooksErrors - Structure and ListEasy SplitEasy Split OverviewEasy Split - Postman CollectionEnd PointsAuthorize - Auto CollectpostVendors 2.0Create Vendor v2.0postUpdate Vendor Details v2.0patchGet Vendor All DetailsgetUpload Vendor DocspostGet Vendor All Document StatusgetGet Vendor Document Download URLgetSplit OrdersSplit at Order LevelpostSplit After PaymentpostCreate Static Split ConfigurationpostGet Split and Settlement Details by OrderID v2.0postCreate Refund with SplitspostSettlementsGet Settlement Cycle DetailsgetGet All Vendor Settlement Details by VendorIDgetVendor Adjustment v2.0postOn Demand Vendor Settlement - Amount BasedGet On Demand BalancegetGet ChargesgetCreate On Demand TransferpostOn Demand Settlements - Interval BasedGet On Demand Vendor BalancegetSettle On Demand Vendor BalancepostGet On Demand Settlement StatusgetDeferred SettlementsSet Vendor Settlement Eligibility Date for OrdersputWebhooksVendor Settlement WebhookVendor Status Change WebhookReconciliationView Split Order Details Using Settlement IDpostVendor Recon for a Time PeriodpostVendor Recon Using Vendor ID & Time IntervalpostCross Border - ImportsCross Border - Imports OverviewImport WebhooksImport Verification APIsUpload Payment Verification DetailspostGet Payment Verification DetailsgetImport Settlement APIsGet Import Settlement detailsgetGet Import Settlement recon detailspostglobal collectionsGlobal Collections OverviewEnd PointsMerchant APIs & WebhookAuthorizatonGet TokenpostVerify TokengetGet All Collection AccountsgetEmulate FundingpostGet All Transaction DetailsgetAdd Transaction DetailspostWebhooks - MerchantPartner APIs & WebhookGet All Collection Accounts for Partner MerchantsgetEmulate Funding for Partner MerchantspostGet All Transaction Details for Partner MerchantsgetAdd Transaction Details for Partner MerchantspostWebhook - PartnerPurpose CodesAuto CollectAuto Collect - Postman CollectionEnd PointsAuto Collect - Easy Split APIsAuthorizepostVerify TokenpostCreate VendorpostEdit VendorputGet All Vendor DetailsgetGet Vendor DetailsgetVirtual Accounts Version 2.0Create Virtual Bank AccountpostCreate Virtual Payment AddresspostEdit Virtual Bank AccountputEdit Virtual Payment AddressputChange Virtual Account StatusputFetch All Virtual AccountsgetFetch Virtual Account by vAccountIdgetVirtual Accounts Version 1.1Create Virtual Account/VPA Version 1.1postEdit Virtual Account Version 1.1postGet Virtual Account or Virtual VPA Details Version 1.1getList All Virtual Accounts Version 1.1getVirtual Accounts Version 1Create Virtual Account / VPApostEdit Virtual AccountpostGet Virtual Account or Virtual VPA DetailsgetList All Virtual AccountsgetCreate QR CodegetCreate Dynamic QR CodegetChange Virtual Account StatuspostRecent PaymentsgetFetch Rejected Payment DetailsgetView Settlement DetailsgetGet Recent Payments for Virtual Account Id/Virtual VPA IdgetSearch for a Transaction by UTRgetFetch Payment by Cashfree Ref IdgetCreate RefundpostGet Refund DetailsgetWebhooksBBPSIntroductionAPIs to ImplementBill FetchgetPayment PostinggetNext Steps for BillerAPIs to IntegrateCheck Transaction StatusgetNPCI Onboarding ConfigurationsSubscription [To Be Deprecated]Subscription - Postman CollectionEnd PointsPhysical MandatesCreate PlanpostCreate Subscription with Plan IDpostCreate Subscription with Plan InfopostSeamless SubscriptionCreate Seamless Subscription with Plan IDpostCreate Seamless Subscription with Plan InfopostCreate Auth Seamless Physical MandatepostCreate Authorisation RequestpostGet Authorisation StatusgetUpdate Authorisation StatusputSubscription Refund APIsCreate RefundpostGet RefundgetGet Subscription DetailsgetUpdate Recurring AmountputGet All Subscription PaymentsgetGet Single Subscription Payment DetailsgetGet Payment Details Using Merchant Txn IDgetCancel SubscriptionpostPause SubscriptionputCharge SubscriptionpostRetry PaymentpostUpload FilepostActivate SubscriptionpostCancel ChargepostUpdate Charge StatusputRedirection Payload after AuthorizationTransaction Return SummarypostRate LimitsWebhooksCreate SubscriptionpostCreate Seamless SubscriptionpostLRSLRS - Postman CollectionEnd PointsMerchant WebhookAdd Webhook URLSpostOrderCreate OrderpostGet OrdergetProcess OrderpostCancel OrderdeleteDocumentsUpload DocumentpostUpload Documents in BulkpostGet A2 FormgetLRS EntitiesCreate CustomerpostCreate RemitterpostGet RemittergetCreate BeneficiarypostGet BeneficiarygetGet FxRatepostGet NetBanking OptionsgetPayoutsPayouts API OverviewGetting Started with Payouts APIsAuthenticationAuthorizepostVerifypostBeneficiaryAdd BeneficiarypostGet Beneficiary DetailsgetGet Beneficiary IDgetRemove BeneficiarypostGet Beneficiary HistorygetAccountGet BalancegetGet Balance V1.2getSelf WithdrawalpostInternal TransferpostInternal Transfer V1.2postCashgramCreate CashgrampostGet Cashgram StatusgetDeactivate CashgrampostPayouts APIs V2 - NewBeneficiary V2Create Beneficiary V2postGet Beneficiary V2getRemove Beneficiary V2deleteTransfer V2Standard Transfer V2postGet Transfer Status V2getBatch Transfer V2postGet Batch Transfer Status V2getBatch Transfers v1.3Get Batch Transfer Status V1.3getTransfers v1.2Standard Transfer Sync v1.2postStandard Transfer Async v1.2postDirect Transfer V1.2postGet Transfer Status V1.2getBatch Transfer V1.2postGet Batch Transfer Status V1.2getTransfersStandard Transfer SyncpostStandard Transfer AsyncpostDirect TransferpostGet Transfer StatusgetBatch TransferpostGet Batch Transfer StatusgetCardPaypostLendpostPayouts Through Phone Number v1.2Standard Transfer Sync v1.2postStandard Transfer Async v1.2postDirect Transfer V1.2postGet Transfer Status V1.2getPayouts Through Phone NumberStandard Transfer SyncpostStandard Transfer AsyncpostDirect TransferpostGet Transfer StatusgetWebhooks V1Webhooks V2IncidentsGet IncidentsgetONEESCROWCreate Virtual AccountpostTransfer Funds Between VAspostGet Account StatementgetAllocate Funds to Virtual AccountpostGet Fund Source DetailsgetWhitelist Bank AccountpostPayouts V2 APIsCashgramCashgram - Postman CollectionEnd PointsAuthenticationAuthorizepostVerifypostCreate CashgrampostGet Cashgram StatusgetDeactivate CashgrampostWebhooksSecure IDSecure ID API OverviewVerification Suite: Server-SDKsEnd Points and Test DataAuthenticationAuthorizepostVerifypostKYC LinksGenerate Form LinkpostGet Form StatusgetGet StatusWebhooksBank Account Verification Version 2Bank Account Verification Sync V2postBank Account Verification Async V2postGet BAV Status V2getBulk Bank Account Verification V2postGet Bulk BAV Status V2getIFSC Verification V2postPANVerify PAN SyncpostGet Status of Verify PAN SyncgetVerify PAN in BulkpostGet Status for Verify PAN in BulkgetPAN Verification via OCRpostGet Status of PAN Verification via OCRgetPAN LitepostPAN 360postAadhaarGenerate OTP to Verify AadhaarpostSubmit OTP to Verify AadhaarpostAadhaar Verification via OCRpostGet Status of Aadhaar Verification via OCRgetAadhaar MaskingpostAccount AggregatorRequest ConsentpostGet Consent StatusgetRequest Financial InformationpostFetch Financial InformationgetOTPLessInitiate OTPLess verificationpostGet verification statusgetGet Terminal Status of otpless verificationgetGSTINVerify GSTINpostFetch GSTIN with PANpostReverse Penny DropCreate Reverse Penny Drop RequestpostGet Reverse Penny Drop Request DetailsgetWebhooksE-signUpload Document For E-SignpostCreate E-Sign RequestpostGet E-Sign StatusgetWebhooksDigilockerCreate DigiLocker URLpostGet DigiLocker Verification StatusgetGet Document from DigiLockergetVehicle RCpostDriving LicencepostVoter IDpostPassportpostCINpostEmployee DetailspostIPpostReverse GeocodingpostLiveliness CheckpostFace MatchpostName MatchpostRetired API VersionsBank Account Verification V1Bank Verification Sync V1.2getBank Verification AsyncgetGet Verification StatusgetIFSC VerificationgetBulk Bank VerificationpostGet Bulk Verification StatusgetUPI Version 1UPI VerificationgetVerification Rate LimitsMerchant Onboarding APIsMerchant OnboardingCreate MerchantpostUpdate MerchantpatchGet Merchant StatusgetUpload DocumentspostCreate Embeddable Onboarding Link (does not require login)postCreate Standard Onboarding Link (with login required by merchant)postMerchant Onboarding WebhooksPRE-ACTIVATED VPAS APICreate Pre-Activated Vpas for partnerpostGet Pre-Activated Vpas for partnergetUpdate Order Extendedput https://sandbox.cashfree.com/pg/orders/{order_id}/extendedUse this api to update the order related data like shipment details,order delivery status etc. When to use this API To provide/update the shipment details or order delivery status. Once the order is PAID.
