POST api/EstoreUtility/ConfirmBill

Request Information

URI Parameters

None.

Body Parameters

BillConfirmationAccountRequest
NameDescriptionTypeAdditional information
paymentReference

string

None.

Request Formats

application/json, text/json

Sample:
{
  "paymentReference": "sample string 1"
}

application/xml, text/xml

Sample:
<UtilityModel.BillConfirmationAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Features.SDK.Models">
  <paymentReference>sample string 1</paymentReference>
</UtilityModel.BillConfirmationAccountRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

QnbDataResponse
NameDescriptionTypeAdditional information
InquiryNumber

string

None.

PartialPayment

string

None.

AccountNumber

string

None.

Amount

decimal number

None.

UnbilledAmount

decimal number

None.

PaymentDueDate

date

None.

ParentNumber

string

None.

CustomerNumber

string

None.

RegisterType

string

None.

MinAmount

string

None.

KmReferenceNumber

string

None.

PoBox

string

None.

CustomerName

string

None.

QpReferenceID

string

None.

LastPaymentDate

date

None.

Status

string

None.

TotalOutstandingAmount

decimal number

None.

CurrentAmountDue

decimal number

None.

UnbilledUsage

decimal number

None.

success

boolean

None.

code

string

None.

message

string

None.

errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "InquiryNumber": "sample string 1",
  "PartialPayment": "sample string 2",
  "AccountNumber": "sample string 3",
  "Amount": 4.0,
  "UnbilledAmount": 5.0,
  "PaymentDueDate": "2025-06-15T07:37:56.3595775+03:00",
  "ParentNumber": "sample string 6",
  "CustomerNumber": "sample string 7",
  "RegisterType": "sample string 8",
  "MinAmount": "sample string 9",
  "KmReferenceNumber": "sample string 10",
  "PoBox": "sample string 11",
  "CustomerName": "sample string 12",
  "QpReferenceID": "sample string 13",
  "LastPaymentDate": "2025-06-15T07:37:56.3595775+03:00",
  "Status": "sample string 14",
  "TotalOutstandingAmount": 15.0,
  "CurrentAmountDue": 16.0,
  "UnbilledUsage": 17.0,
  "success": true,
  "code": "sample string 19",
  "message": "sample string 20",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<UtilityModel.QnbDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Features.SDK.Models">
  <code xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 19</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 20</message>
  <success xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">true</success>
  <AccountNumber>sample string 3</AccountNumber>
  <Amount>4</Amount>
  <CurrentAmountDue>16</CurrentAmountDue>
  <CustomerName>sample string 12</CustomerName>
  <CustomerNumber>sample string 7</CustomerNumber>
  <InquiryNumber>sample string 1</InquiryNumber>
  <KmReferenceNumber>sample string 10</KmReferenceNumber>
  <LastPaymentDate>2025-06-15T07:37:56.3595775+03:00</LastPaymentDate>
  <MinAmount>sample string 9</MinAmount>
  <ParentNumber>sample string 6</ParentNumber>
  <PartialPayment>sample string 2</PartialPayment>
  <PaymentDueDate>2025-06-15T07:37:56.3595775+03:00</PaymentDueDate>
  <PoBox>sample string 11</PoBox>
  <QpReferenceID>sample string 13</QpReferenceID>
  <RegisterType>sample string 8</RegisterType>
  <Status>sample string 14</Status>
  <TotalOutstandingAmount>15</TotalOutstandingAmount>
  <UnbilledAmount>5</UnbilledAmount>
  <UnbilledUsage>17</UnbilledUsage>
</UtilityModel.QnbDataResponse>