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

Status	Description
`CREATED`	Payment request is created
`AUTHORIZED`	Transaction successfully authorized by the customer after OTP completion
`PENDING_WITH_BANK`	Response awaited from the customer's bank
`SUCCESS`	Payment is sucessful
`FAILED`	Payment failed
`CANCELLED`	Payment cancelled by the customer
`PARTIALLY_REFUNDED`	Partial transaction amount was refunded
`REFUNDED`	Transaction 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

Field	Type	Required	Description
`orderId`	string	Yes	Unique identifier for the order
`paymentDetail`	object	No	Contains details for processing the payment
`paymentMode`	string	Yes	Mode of payment. Allowed values: NET_BANKING, UPI, CREDIT_CARD, DEBIT_CARD, PREPAID_CARD, PAY_LATER, WALLET, CORPORATE_CARD
`cardHolderName`	string	No	Required for card payments
`cardNumber`	string	No	Required for card payments
`cvv`	string	No	Required for card payments
`expiry`	string	No	Required for card payments
`bankCode`	string	No	Required for NetBanking, BNPL, and Wallet payment modes
`bnplPaymentOptionId`	string	No	Required for BNPL payment mode
`vpa`	string	No	Required for UPI payment mode
`accountNumber`	string	No	Required for UPI TPV flow. Must be between 9 and 36 characters
`ifsc`	string	No	Required for UPI TPV flow. Must be 11 characters and follow the pattern ^[A-Z]{4}0[A-Z0-9]{6}$

Last modified: 4 months ago