EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Payments
  • Payment Gateway Overview
  • Payment Gateway Sign Up
  • Payment Methods
  • Supported Integrations
  • Payment APIs
  • Test Card Details
  • Authorization
    • About Authorization
    • Get Authorization Token
      POST
  • Orders
    • Order Overview
    • About Order
    • Create Order
      POST
    • Get Order Status
      GET
    • Get BNPL Payment Modes
      GET
  • Payments
    • Payment Overview
    • About Payment
    • Get Transaction Status
      GET
    • Submit Payment Detail
      POST
  • Refunds
    • About Refund
    • Refund
      POST
  • Payment Links
    • Upi Intent Link Detail
      GET
  • Settlements
    • About Settlement
    • Get Settlement Payout By Id
      GET
    • Search Settlement Payouts
      POST
  • QR Generation API
    • Get Dynamic QR Code
  • Payment Button
  • Qr Code
    • Create QR
    • Create QR Customer
    • Search QR Code
    • Get QR Code
    • Cancel QR Code
  1. Payments

About Payment

Understand how to manage and track various payment states efficiently#

The Olympus payment gateway provides a secure and efficient method for processing online transactions. To initiate a payment, a payment request object must be created and sent to the gateway. Understanding the structure and required fields of this object is crucial for seamless transaction processing.
Once your account is activated, you can start accepting live payments using the Enkash Olympus Payment Gateway

Payment Lifecycle#

StatusDescription
CREATEDPayment request is created
AUTHORIZEDTransaction successfully authorized by the customer after OTP completion
PENDING_WITH_BANKResponse awaited from the customer's bank
SUCCESSPayment is sucessful
FAILEDPayment failed
CANCELLEDPayment cancelled by the customer
PARTIALLY_REFUNDEDPartial transaction amount was refunded
REFUNDEDTransaction was fully refunded

Payment Request Structure#

The payment request object is a JSON structure that includes all the necessary details required by the Olympus payment gateway to process a payment. This object contains below information about the transaction
FieldTypeRequiredDescription
orderIdstringYesUnique identifier for the order
paymentDetailobjectNoContains details for processing the payment
paymentModestringYesMode of payment. Allowed values: NET_BANKING, UPI, CREDIT_CARD, DEBIT_CARD, PREPAID_CARD, PAY_LATER, WALLET, CORPORATE_CARD
cardHolderNamestringNoRequired for card payments
cardNumberstringNoRequired for card payments
cvvstringNoRequired for card payments
expirystringNoRequired for card payments
bankCodestringNoRequired for NetBanking, BNPL, and Wallet payment modes
bnplPaymentOptionIdstringNoRequired for BNPL payment mode
vpastringNoRequired for UPI payment mode
accountNumberstringNoRequired for UPI TPV flow. Must be between 9 and 36 characters
ifscstringNoRequired for UPI TPV flow. Must be 11 characters and follow the pattern ^[A-Z]{4}0[A-Z0-9]{6}$
Previous
Payment Overview
Next
Get Transaction Status
Built with