# Payment Confirmation

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/payment/req-pay-confirmation:
    post:
      summary: Payment Confirmation
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to confirm the payment status of an invoice or transaction
        in your EnKash account.

        This helps you verify that a payment has been successfully processed,
        update your internal records, and trigger any post-payment workflows
        like sending receipts or updating order statuses.


        :::
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Payment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentConfirmationRequest'
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  payload:
                    type: string
                  response_code:
                    type: integer
                  response_message:
                    type: string
                required:
                  - payload
                  - response_code
                  - response_message
                x-apidog-orders:
                  - payload
                  - response_code
                  - response_message
                x--orders:
                  - payload
                  - response_code
                  - response_message
                x--ignore-properties: []
              example:
                payload: SUCCESS
                response_code: 0
                response_message: SUCCESS
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Payment
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10664768-run
components:
  schemas:
    PaymentConfirmationRequest:
      required:
        - device
        - b2bIds
        - paymentConfirmation
      type: object
      properties:
        device:
          $ref: '#/components/schemas/Device'
        b2bIds:
          $ref: '#/components/schemas/NbblB2BIdsModel'
        paymentConfirmation:
          $ref: '#/components/schemas/PaymentConfirmation'
      x-apidog-orders:
        - device
        - b2bIds
        - paymentConfirmation
      x--orders:
        - device
        - b2bIds
        - paymentConfirmation
      x--ignore-properties: []
      x-apidog-folder: ''
    PaymentConfirmation:
      required:
        - objectId
        - ts
        - type
        - supplierResponse
        - supplierRemarks
        - invoiceInfos
      type: object
      properties:
        objectId:
          type: string
          pattern: ^[PMT]{3}[A-Za-z0-9]{32,32}$
          description: |-
            Unique object ID for the
            payment transaction as per
            ReqPay
        ts:
          type: string
        type:
          type: string
          enum:
            - OFFPLATFORM
            - ONPLATFORM
        supplierResponse:
          type: string
          enum:
            - ACCEPT
            - REJECT
          x-apidog-enum:
            - value: ACCEPT
              name: ' '
              description: ''
            - value: REJECT
              name: ''
              description: ''
          description: |-
            Response of supplier
            Rule: REJECT is only for
            offplatform payment
        supplierRemarks:
          type: string
          pattern: ^([^\\\"]){1,100}$
        invoiceInfos:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceInfo'
      x-apidog-orders:
        - objectId
        - ts
        - type
        - supplierResponse
        - supplierRemarks
        - invoiceInfos
      x--orders:
        - objectId
        - ts
        - type
        - supplierResponse
        - supplierRemarks
        - invoiceInfos
      x--ignore-properties: []
      x-apidog-folder: ''
    InvoiceInfo:
      required:
        - objectId
        - supplierInvoiceNumber
        - objectVersion
        - statusTransition
      type: object
      properties:
        objectId:
          type: string
          pattern: ^[INV]{3}[A-Za-z0-9]{32,32}$
          x-apidog-mock: Invoice object ID on B2B Platform
        supplierInvoiceNumber:
          type: string
          pattern: '^([^\\\"]){1,50}$ '
        objectVersion:
          $ref: '#/components/schemas/ObjectVersion'
        statusTransition:
          $ref: '#/components/schemas/StatusTransition'
      x-apidog-orders:
        - objectId
        - supplierInvoiceNumber
        - objectVersion
        - statusTransition
      x--orders:
        - objectId
        - supplierInvoiceNumber
        - objectVersion
        - statusTransition
      x--ignore-properties: []
      x-apidog-folder: ''
    StatusTransition:
      required:
        - currentStatus
        - newStatus
      type: object
      properties:
        currentStatus:
          type: string
          enum:
            - CREATED
            - SENT TO BUYER
            - ACCEPTED
            - REJECTED
            - UNDER REVIEW
            - CANCELLED
            - DELETED
            - PARTIALLY PAID
            - FULLY PAID
            - CLOSED
            - ABANDONED
            - PAYMENT INITIATED
            - PARTIALLY PAID AND PAYMENT INITIATED
          x-apidog-enum:
            - value: CREATED
              name: ''
              description: ''
            - value: SENT TO BUYER
              name: ''
              description: ''
            - value: ACCEPTED
              name: ''
              description: ''
            - value: REJECTED
              name: ''
              description: ''
            - value: UNDER REVIEW
              name: ''
              description: ''
            - value: CANCELLED
              name: ''
              description: ''
            - value: DELETED
              name: ''
              description: ''
            - value: PARTIALLY PAID
              name: ''
              description: ''
            - value: FULLY PAID
              name: ''
              description: ''
            - value: CLOSED
              name: ''
              description: ''
            - value: ABANDONED
              name: ''
              description: ''
            - value: PAYMENT INITIATED
              name: ''
              description: ''
            - value: PARTIALLY PAID AND PAYMENT INITIATED
              name: ''
              description: ''
        newStatus:
          type: string
          enum:
            - CREATED
            - SENT TO BUYER
            - ACCEPTED
            - REJECTED
            - UNDER REVIEW
            - CANCELLED
            - DELETED
            - PARTIALLY PAID
            - FULLY PAID
            - CLOSED
            - ABANDONED
            - PAYMENT INITIATED
            - PARTIALLY PAID AND PAYMENT INITIATED
          x-apidog-enum:
            - value: CREATED
              name: ''
              description: ''
            - value: SENT TO BUYER
              name: ''
              description: ''
            - value: ACCEPTED
              name: ''
              description: ''
            - value: REJECTED
              name: ''
              description: ''
            - value: UNDER REVIEW
              name: ''
              description: ''
            - value: CANCELLED
              name: ''
              description: ''
            - value: DELETED
              name: ''
              description: ''
            - value: PARTIALLY PAID
              name: ''
              description: ''
            - value: FULLY PAID
              name: ''
              description: ''
            - value: CLOSED
              name: ''
              description: ''
            - value: ABANDONED
              name: ''
              description: ''
            - value: PAYMENT INITIATED
              name: ''
              description: ''
            - value: PARTIALLY PAID AND PAYMENT INITIATED
              name: ''
              description: ''
      x-apidog-orders:
        - currentStatus
        - newStatus
      x--orders:
        - currentStatus
        - newStatus
      x--ignore-properties: []
      x-apidog-folder: ''
    ObjectVersion:
      required:
        - currentVersion
        - newVersion
      type: object
      properties:
        currentVersion:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          default: 1
        newVersion:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          default: 1
      x-apidog-orders:
        - currentVersion
        - newVersion
      x--orders:
        - currentVersion
        - newVersion
      x--ignore-properties: []
      x-apidog-folder: ''
    NbblB2BIdsModel:
      required:
        - buyerB2BId
        - supplierB2BId
      type: object
      properties:
        buyerB2BId:
          type: string
          pattern: '^([^\\\"]){1,100}$ '
        supplierB2BId:
          type: string
          pattern: '^([^\\\"]){1,100}$ '
      x-apidog-orders:
        - buyerB2BId
        - supplierB2BId
      x--orders:
        - buyerB2BId
        - supplierB2BId
      x--ignore-properties: []
      x-apidog-folder: ''
    Device:
      type: object
      properties:
        tag:
          $ref: '#/components/schemas/Tag'
      x-apidog-orders:
        - tag
      required:
        - tag
      x--orders:
        - tag
      x--ignore-properties: []
      x-apidog-folder: ''
    Tag:
      type: object
      properties:
        name:
          type: string
          enum:
            - GEOCODE
            - IP
            - AGENTID
        value:
          type: string
          pattern: ^([^\\\"]){1,100}$
      x-apidog-orders:
        - name
        - value
      required:
        - name
        - value
      x--orders:
        - name
        - value
      x--ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```