About Payment

Payment Lifecycle and Payment Request Structure

The Olympus Payment Gateway offers a secure and efficient platform for processing online transactions. To initiate a payment, a well-structured payment request object must be created and sent to the gateway. This guide explains the payment lifecycle and the required fields for building a seamless payment request.

Payment Lifecycle

Understanding the various payment states is critical for efficient transaction management

Status	Description
CREATED	Payment request has been created.
AUTHORIZED	Transaction successfully authorized by the customer after OTP completion.
PENDING_WITH_BANK	Awaiting response from the customer’s bank.
SUCCESS	Payment completed successfully.
FAILED	Payment failed.
CANCELLED	Payment cancelled by the customer.
PARTIALLY_REFUNDED	A portion of the transaction amount was refunded.
REFUNDED	The full transaction amount was refunded.

Payment Request Structure

The payment request object is a JSON payload containing all necessary details for processing a transaction. Below is an overview of the structure and required fields:

Field	Type	Required	Description
`orderId`	`string`	Yes	Unique identifier for the order.
`paymentDetail`	`object`	No	Additional details required for payment processing.
`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. Format: `MM/YY`.
`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, matching the pattern `^[A-Z]{4}0[A-Z0-9]{6}$`.

Example Payment Request

Here’s an example of a complete payment request object:

{  
  "orderId": "ORD123456789",  
  "paymentDetail": {  
    "amount": 1000,  
    "currency": "INR"  
  },  
  "paymentMode": "CREDIT_CARD",  
  "cardHolderName": "John Doe",  
  "cardNumber": "4111111111111111",  
  "cvv": "123",  
  "expiry": "12/24",  
  "bankCode": "HDFC",  
  "vpa": "john.doe@upi",  
  "accountNumber": "123456789012",  
  "ifsc": "HDFC0001234"  
}

Key Considerations

Order ID Uniqueness: Ensure the orderId is unique for each transaction to prevent duplication.

Mandatory Fields: Always provide required fields (orderId and paymentMode) based on the chosen payment method.

Validation: Validate field formats (e.g., card number, CVV, IFSC code) to prevent errors during processing.

Error Handling: Implement error handling to manage different payment states, especially FAILED and PENDING_WITH_BANK.

Submit Payment Detail
Get Transaction Status
Validate OTP
Resend OTP

Payment Lifecycle and Payment Request Structure#

Payment Lifecycle#

Payment Request Structure#

Example Payment Request#

Key Considerations#

Related Pages:#

Payment Lifecycle and Payment Request Structure

Payment Lifecycle

Payment Request Structure

Example Payment Request

Key Considerations

Related Pages: