# Get Utility Bill Status ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v2/utilityPayment/{utilityEnkashId}: get: summary: Get Utility Bill Status deprecated: false description: >- :::highlight purple 📌 Use this API to retrieve the current status of a specific utility bill, such as whether it is pending, paid, or failed. By providing the appropriate reference ID or transaction identifier, you can easily track the payment lifecycle and keep your records up to date. ::: tags: - Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Fetch Bill parameters: - name: utilityEnkashId in: path description: '' required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: >- #/components/schemas/ApplicationResponseUtilityPaymentV2Response example: response_code: 0 response_message: string payload: companyName: string utilityEnkashId: string amount: 0 consumerNumber: string consumerName: string billDate: '2025-06-02' billDueDate: '2025-06-02' createdDate: '2025-06-02T14:24:14.670Z' billNumber: string billerBillNumber: string numberOfUnits: 0 approvalStatus: MAKER_APPROVAL_PENDING approvalRemarks: string paymentStatus: INIT billpayStatus: SUCCESS failureReason: string failureCode: UTEX001 paymentDate: '2025-06-02T14:24:14.670Z' billpayDate: '2025-06-02T14:24:14.670Z' paymentMode: CREDIT_CARD approvedDate: '2025-06-02T14:24:14.670Z' billReferenceId: string billStartDate: '2025-06-02' billEndDate: '2025-06-02' remarks: string companyBiller: companyBillerId: string companyName: string companyId: string biller: billerId: 0 name: string billerType: string inputParams: - paramKey: string paramName: string paramType: NUMBER paramRegex: string invalidParamError: string mandatory: true paramValues: - key: string value: string circleParams: - key: string value: AP paymentAmountExactness: string state: ANDAMAN_AND_NICOBAR_ISLANDS circleStateMapping: additionalProp1: ANDAMAN_AND_NICOBAR_ISLANDS additionalProp2: ANDAMAN_AND_NICOBAR_ISLANDS additionalProp3: ANDAMAN_AND_NICOBAR_ISLANDS viewBillSupported: true circleEnum: AP billInputParams: string billerParams: - key: string name: string value: string paramType: NUMBER consumerNumber: string consumerName: string createdDate: '2025-06-02T14:24:14.671Z' lastDueDate: '2025-06-02' billFetchFailureMessage: string billAmount: 0 earlyPaymentDate: '2025-06-02' earlyPaymentAmount: 0 latePaymentAmount: 0 actualDueDate: '2025-06-02' companyId: string bankTransactionId: string referenceId: string refund: refundDate: '2025-06-02T14:24:14.671Z' refundAmount: 0 refundMode: CREDIT_CARD instrument: string refundTransactionId: string refundStatus: string refundReason: string headers: {} x-apidog-name: Success security: - bearer: [] x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Fetch Bill x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10664797-run components: schemas: ApplicationResponseUtilityPaymentV2Response: type: object properties: response_code: type: integer description: This field holds the status or response code of the API request. response_message: type: string description: >- This field represents the response message or status description associated with the API request. payload: $ref: '#/components/schemas/UtilityPaymentV2Response' required: - response_code - response_message - payload x-apidog-orders: - response_code - response_message - payload x-apidog-refs: {} x-apidog-ignore-properties: [] x-apidog-folder: '' UtilityPaymentV2Response: type: object properties: companyName: type: string utilityEnkashId: type: string amount: type: integer consumerNumber: type: string consumerName: type: string billDate: type: string billDueDate: type: string createdDate: type: string billNumber: type: string billerBillNumber: type: string numberOfUnits: type: integer approvalStatus: type: string approvalRemarks: type: string paymentStatus: type: string billpayStatus: type: string failureReason: type: string failureCode: type: string paymentDate: type: string billpayDate: type: string paymentMode: type: string approvedDate: type: string billReferenceId: type: string billStartDate: type: string billEndDate: type: string remarks: type: string companyBiller: type: object properties: companyBillerId: type: string companyName: type: string companyId: type: string biller: type: object properties: billerId: type: integer name: type: string billerType: type: string inputParams: type: array items: type: object properties: paramKey: type: string paramName: type: string paramType: type: string paramRegex: type: string invalidParamError: type: string mandatory: type: boolean paramValues: type: array items: type: object properties: key: type: string value: type: string x-apidog-orders: - key - value x-apidog-ignore-properties: [] x-apidog-orders: - paramKey - paramName - paramType - paramRegex - invalidParamError - mandatory - paramValues x-apidog-ignore-properties: [] circleParams: type: array items: type: object properties: key: type: string value: type: string x-apidog-orders: - key - value x-apidog-ignore-properties: [] paymentAmountExactness: type: string state: type: string circleStateMapping: type: object properties: additionalProp1: type: string additionalProp2: type: string additionalProp3: type: string required: - additionalProp1 - additionalProp2 - additionalProp3 x-apidog-orders: - additionalProp1 - additionalProp2 - additionalProp3 x-apidog-ignore-properties: [] viewBillSupported: type: boolean required: - billerId - name - billerType - inputParams - circleParams - paymentAmountExactness - state - circleStateMapping - viewBillSupported x-apidog-orders: - billerId - name - billerType - inputParams - circleParams - paymentAmountExactness - state - circleStateMapping - viewBillSupported x-apidog-ignore-properties: [] circleEnum: type: string billInputParams: type: string billerParams: type: array items: type: object properties: key: type: string name: type: string value: type: string paramType: type: string x-apidog-orders: - key - name - value - paramType x-apidog-ignore-properties: [] consumerNumber: type: string consumerName: type: string createdDate: type: string lastDueDate: type: string billFetchFailureMessage: type: string required: - companyBillerId - companyName - companyId - biller - circleEnum - billInputParams - billerParams - consumerNumber - consumerName - createdDate - lastDueDate - billFetchFailureMessage x-apidog-orders: - companyBillerId - companyName - companyId - biller - circleEnum - billInputParams - billerParams - consumerNumber - consumerName - createdDate - lastDueDate - billFetchFailureMessage x-apidog-ignore-properties: [] billAmount: type: integer earlyPaymentDate: type: string earlyPaymentAmount: type: integer latePaymentAmount: type: integer actualDueDate: type: string companyId: type: string bankTransactionId: type: string referenceId: type: string refund: type: object properties: refundDate: type: string refundAmount: type: integer refundMode: type: string instrument: type: string refundTransactionId: type: string refundStatus: type: string refundReason: type: string required: - refundDate - refundAmount - refundMode - instrument - refundTransactionId - refundStatus - refundReason x-apidog-orders: - refundDate - refundAmount - refundMode - instrument - refundTransactionId - refundStatus - refundReason x-apidog-ignore-properties: [] required: - companyName - utilityEnkashId - amount - consumerNumber - consumerName - billDate - billDueDate - createdDate - billNumber - billerBillNumber - numberOfUnits - approvalStatus - approvalRemarks - paymentStatus - billpayStatus - failureReason - failureCode - paymentDate - billpayDate - paymentMode - approvedDate - billReferenceId - billStartDate - billEndDate - remarks - companyBiller - billAmount - earlyPaymentDate - earlyPaymentAmount - latePaymentAmount - actualDueDate - companyId - bankTransactionId - referenceId - refund x-apidog-orders: - companyName - utilityEnkashId - amount - consumerNumber - consumerName - billDate - billDueDate - createdDate - billNumber - billerBillNumber - numberOfUnits - approvalStatus - approvalRemarks - paymentStatus - billpayStatus - failureReason - failureCode - paymentDate - billpayDate - paymentMode - approvedDate - billReferenceId - billStartDate - billEndDate - remarks - companyBiller - billAmount - earlyPaymentDate - earlyPaymentAmount - latePaymentAmount - actualDueDate - companyId - bankTransactionId - referenceId - refund x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: bearer: type: http scheme: bearer servers: - url: https://ekpayout-uat.enkash.in description: Testing Env security: [] ```