Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Payment Gateway
  • Payment Gateway Overview
  • Getting Started
  • Payment Methods
  • Integration
  • API Endpoints
  • APIs
    • Authorisation
      • Get Authorization Token
    • Order
      • Create Order
      • Get Order Status
      • Get Order By Merchant Order Id
      • Get BNPL Payment Modes
      • Get Dynamic QR Code
      • UPI Intent Links
    • Payment
      • Submit Payment Detail
      • Get Transaction Status
      • Validate OTP
      • Resend OTP
      • Payment Notify Request
      • Get UPI Transaction Status
      • Verify VPA
    • Refund
      • Refund
    • Settlement
      • Settlement Reporting
      • Get Settlement Payout By ID
      • Search Settlement Payouts
    • Split Settlement
      • Create Split Settlement Account
      • Update Split Settlement Account
      • Get All Split Settlement Account
      • Deactivate Split Settlement Account
      • Activate Split Settlement Account
      • Submit Payment with Split Details
      • Edit/Deferred Split Settlement
    • E-Commerce Plugins
    • Payment Button
    • Qr Code
      • Create Qr Code
      • Get QR Code
      • Search QR Code
      • createCustomer
      • searchCustomer
      • Cancel QR Code
    • UPI Mandate
      • Create UPI Mandate
      • Update UPI Mandate
      • Revoke UPI Mandate
      • Get UPI Mandate
      • UPI mandate create callback
      • Mandate Pre-debit Notification
      • Execute mandate debit
      • Mandate Debit callback
    • Payment Links
      • Payment Links Overview
      • Payment Link APIs
      • Payment Link
        • Create Payment Link
        • Get Payment Link Details
        • Delete Payment Link
      • Payment Link Webhook
        • Payment Link Webhook Request
  1. Payment Gateway

API Endpoints Overview

The EnKash Payment Gateway offers a comprehensive set of RESTful APIs for managing authentication, orders, payments, refunds, and settlements. Use the appropriate base URL and API key depending on your environment.

Base URL#

EnvironmentBase URL
Testhttps://olympus-pg-uat.enkash.in
Livehttps://olympus-pg.enkash.in

Setup#

Test Environment:
After registering, you will receive sandbox API keys at your registered email.
Live Environment:
Production API keys are shared upon successful completion of integration testing and approval by EnKash.

API Categories and Endpoints#

Authorization APIs
Used to manage authentication and secure access to all other API calls.
API NameFunction
Get Authentication TokenRetrieve an access token required for all secured API calls.
Order APIs
Used to create, track, and manage orders and payment initiation data.
API NameFunction
Create OrderCreate a new payment order.
Get Order StatusRetrieve the current status of an order.
Get BNPL Payment ModesFetch available BNPL payment options based on mobile number.
Get Dynamic QR CodeGenerate a dynamic UPI QR code for a specific order.
UPI Intent LinkGenerate a deep link to launch a UPI app with pre-filled payment data.
Payment APIs
Manage the full lifecycle of a payment including submission, tracking, and user verification.
API NameFunction
Submit PaymentSubmit user payment details to initiate processing.
Get Payment StatusRetrieve the status of a submitted payment.
Validate OTPVerify OTP entered by the user (if applicable).
Resend OTPTrigger re-sending of OTP to the user.
Payment Notify RequestSend or retrieve a payment notification manually.
Refund APIs
Enable full or partial refunds for completed payments.
API NameFunction
Initiate RefundInitiate a refund for a successful payment.
Settlement APIs
Retrieve and search settlement reports for reconciliation and reporting.
API NameFunction
Get Settlement Details By IDFetch settlement details using a specific ID.
Search For A SettlementSearch settlements based on date range, status, etc.
Previous
Integration
Next
Authorisation
Built with