# Payment Notify Request

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /merchant_url:
    post:
      summary: Payment Notify Request
      deprecated: false
      description: >+

        :::highlight purple 📌

        Use this API to receive payment status notifications from Enkash. You
        must develop this API on your backend to handle incoming payment updates
        (such as success or failure). Provide the endpoint URL in the Create
        Order API so Enkash can notify your system when the payment status
        changes.

        :::

      tags:
        - Payment Gateway/APIs - Payment Gateway /Payment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: string
                  description: Original transaction amount.
                  examples:
                    - '12457.00'
                bankCode:
                  type: string
                  description: Bank code associated with the payment instrument.
                  examples:
                    - null
                  nullable: true
                bankName:
                  type: string
                  description: Name of the issuing or acquiring bank.
                  examples:
                    - RBL
                bankTransactionId:
                  type: string
                  description: Transaction reference number provided by the bank.
                  examples:
                    - '616216888065'
                cardHolderName:
                  type: string
                  description: Name of the card holder.
                  examples:
                    - Mayank
                cardIsinNumber:
                  type: string
                  description: Card issuer identification number (if available).
                  examples:
                    - null
                  nullable: true
                cardScheme:
                  type: string
                  description: Card scheme used for the transaction.
                  examples:
                    - MASTERCARD
                checksum:
                  type: string
                  description: >-
                    Checksum signature generated by EnKash for response
                    verification. Use this checksum along with your configured
                    secret key to verify the authenticity and integrity of the
                    callback payload.
                  examples:
                    - >-
                      wG8JcfAM3QifIIQup6DTnkAqd/NTqh+QiwQ2hIYN4O/4xOsXdQgdcr6IeR9A6dkFMJ87c0UxmMlViAsS1EBkAoBXvqwGVSc1wC24ouZHN2E=
                convenienceFee:
                  type: number
                  description: Convenience fee charged for the transaction.
                  examples:
                    - 0
                convenienceFeeGst:
                  type: number
                  description: GST applied on the convenience fee.
                  examples:
                    - 0
                currency:
                  type: string
                  description: Currency of the transaction.
                  examples:
                    - INR
                customParameters:
                  type: object
                  description: Custom parameters passed during order creation.
                  examples:
                    - null
                  x-apidog-orders: []
                  nullable: true
                finalAmount:
                  type: string
                  description: Final amount charged to the customer.
                  examples:
                    - '12457.00'
                maskedCardNumber:
                  type: string
                  description: Masked card number used for the transaction.
                  examples:
                    - XXXX XXXX XXXX 9178
                orderId:
                  type: string
                  description: Unique EnKash order identifier.
                  examples:
                    - ORD1781174550092jO10n
                orderStatus:
                  type: string
                  description: Current order status.
                  examples:
                    - PAID
                paymentMode:
                  type: string
                  description: Payment mode used for the transaction.
                  enum:
                    - NET_BANKING
                    - UPI
                    - CREDIT_CARD
                    - DEBIT_CARD
                    - PREPAID_CARD
                    - WALLET
                    - CORPORATE_CARD
                    - POS
                  x-apidog-enum:
                    - value: NET_BANKING
                      description: Net Banking
                    - value: UPI
                      description: UPI
                    - value: CREDIT_CARD
                      description: Credit Card
                    - value: DEBIT_CARD
                      description: Debit Card
                    - value: PREPAID_CARD
                      description: Prepaid Card
                    - value: WALLET
                      description: Wallet
                    - value: CORPORATE_CARD
                      description: Corporate Card
                    - value: POS
                      description: Point of Sale
                  examples:
                    - CREDIT_CARD
                paymentToken:
                  type: string
                  description: Payment token associated with the transaction.
                  examples:
                    - 1d90fe90b6f06125b70dc
                productId:
                  type: string
                  description: Internal product identifier.
                  examples:
                    - null
                  nullable: true
                status:
                  type: string
                  description: Current transaction status.
                  examples:
                    - SUCCESS
                surcharge:
                  type: string
                  description: Surcharge applied to the transaction.
                  examples:
                    - '0.00'
                surchargeGst:
                  type: string
                  description: GST applied on the surcharge.
                  examples:
                    - '0.00'
                transactionAmount:
                  type: number
                  description: Transaction amount before surcharge and taxes.
                  examples:
                    - 12457
                transactionId:
                  type: string
                  description: Unique EnKash transaction identifier.
                  examples:
                    - EK1781174578299f7Alm
                transactionType:
                  type: string
                  description: Transaction type.
                  examples:
                    - null
                  nullable: true
                txnDate:
                  type: string
                  description: 'Transaction timestamp. Format: yyyy-MM-dd HH:mm:ss (IST).'
                  examples:
                    - '2026-06-11 16:13:44'
                txnMsg:
                  type: string
                  description: Transaction message returned by the payment gateway.
                  examples:
                    - Transaction Successful
                uniqueTransactionId:
                  type: string
                  description: >-
                    Unique transaction reference generated by the payment
                    gateway.
                  examples:
                    - 58c3446329db42c3a67d66903778c8c9
              required:
                - amount
                - bankName
                - bankTransactionId
                - cardHolderName
                - cardScheme
                - checksum
                - currency
                - finalAmount
                - maskedCardNumber
                - orderId
                - orderStatus
                - paymentMode
                - status
                - transactionAmount
                - transactionId
                - txnDate
                - txnMsg
                - uniqueTransactionId
              x-apidog-orders:
                - amount
                - bankCode
                - bankName
                - bankTransactionId
                - cardHolderName
                - cardIsinNumber
                - cardScheme
                - checksum
                - convenienceFee
                - convenienceFeeGst
                - currency
                - customParameters
                - finalAmount
                - maskedCardNumber
                - orderId
                - orderStatus
                - paymentMode
                - paymentToken
                - productId
                - status
                - surcharge
                - surchargeGst
                - transactionAmount
                - transactionId
                - transactionType
                - txnDate
                - txnMsg
                - uniqueTransactionId
              examples:
                - amount: '12457.00'
                  bankCode: null
                  bankName: RBL
                  bankTransactionId: '616216888065'
                  cardHolderName: Mayank
                  cardIsinNumber: null
                  cardScheme: MASTERCARD
                  checksum: >-
                    wG8JcfAM3QifIIQup6DTnkAqd/NTqh+QiwQ2hIYN4O/4xOsXdQgdcr6IeR9A6dkFMJ87c0UxmMlViAsS1EBkAoBXvqwGVSc1wC24ouZHN2E=
                  convenienceFee: 0
                  convenienceFeeGst: 0
                  currency: INR
                  customParameters: null
                  finalAmount: '12457.00'
                  maskedCardNumber: XXXX XXXX XXXX 9178
                  orderId: ORD1781174550092jO10n
                  orderStatus: PAID
                  paymentMode: CREDIT_CARD
                  paymentToken: 1d90fe90b6f06125b70dc
                  productId: null
                  status: SUCCESS
                  surcharge: '0.00'
                  surchargeGst: '0.00'
                  transactionAmount: 12457
                  transactionId: EK1781174578299f7Alm
                  transactionType: null
                  txnDate: '2026-06-11 16:13:44'
                  txnMsg: Transaction Successful
                  uniqueTransactionId: 58c3446329db42c3a67d66903778c8c9
            example:
              amount: '12457.00'
              bankCode: null
              bankName: RBL
              bankTransactionId: '616216888065'
              cardHolderName: Mayank
              cardIsinNumber: null
              cardScheme: MASTERCARD
              checksum: >-
                wG8JcfAM3QifIIQup6DTnkAqd/NTqh+QiwQ2hIYN4O/4xOsXdQgdcr6IeR9A6dkFMJ87c0UxmMlViAsS1EBkAoBXvqwGVSc1wC24ouZHN2E=
              convenienceFee: 0
              convenienceFeeGst: 0
              currency: INR
              customParameters: null
              finalAmount: '12457.00'
              maskedCardNumber: XXXX XXXX XXXX 9178
              orderId: ORD1781174550092jO10n
              orderStatus: PAID
              paymentMode: CREDIT_CARD
              paymentToken: 1d90fe90b6f06125b70dc
              productId: null
              status: SUCCESS
              surcharge: '0.00'
              surchargeGst: '0.00'
              transactionAmount: 12457
              transactionId: EK1781174578299f7Alm
              transactionType: null
              txnDate: '2026-06-11 16:13:44'
              txnMsg: Transaction Successful
              uniqueTransactionId: 58c3446329db42c3a67d66903778c8c9
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                required:
                  - status
                  - message
                x-apidog-orders:
                  - status
                  - message
                x-apidog-refs: {}
              example:
                status: 1
                message: Callback Received
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /Payment
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-13510838-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```
