POST Api/BillPayments/GetBillPaymentProgress

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BillPaymentID	globally unique identifier	None.
Username	string	None.
Password	string	None.
DeviceManufacturer	string	None.
DeviceModel	string	None.
DeviceSDKInt	string	None.
DeviceSDKVersion	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BillPaymentID": "3b155459-ca2d-46a4-9a13-61a7a6eee93e",
  "Username": "sample string 2",
  "Password": "sample string 3",
  "DeviceManufacturer": "sample string 4",
  "DeviceModel": "sample string 5",
  "DeviceSDKInt": "sample string 6",
  "DeviceSDKVersion": "sample string 7"
}

application/xml, text/xml

Sample:

<GetBillPaymentProgressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 4</DeviceManufacturer>
  <DeviceModel>sample string 5</DeviceModel>
  <DeviceSDKInt>sample string 6</DeviceSDKInt>
  <DeviceSDKVersion>sample string 7</DeviceSDKVersion>
  <Password>sample string 3</Password>
  <Username>sample string 2</Username>
  <BillPaymentID>3b155459-ca2d-46a4-9a13-61a7a6eee93e</BillPaymentID>
</GetBillPaymentProgressRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetBillPaymentProgressRequest'.

Response Information

Resource Description

GetBillPaymentProgressResponse

Name	Type	Additional information
PayBillComplete	Collection of PayBillComplete	None.
BillPaymentComplete	boolean	None.
BillMessage	string	None.
BillItemComplete	PayBillComplete	None.
Success	boolean	None.
ErrorMessage	string	None.
ServerDateTime	string	None.
ErrorType	Errors	None.

Response Formats

application/json, text/json

Sample:

{
  "PayBillComplete": [
    {
      "BillPaymentID": "d9678689-54bf-4214-ae4a-43082761afc5",
      "BillPaymentItemID": "98d52e7b-a95d-41d2-aded-be0357db5ad3",
      "AccountNumber": "sample string 3",
      "Reference": "sample string 4",
      "PayBillAmountEachBillFormatted": "sample string 5",
      "BillItemPending": true,
      "BillItemProcessed": true,
      "TransactionDateTime": "sample string 8"
    },
    {
      "BillPaymentID": "d9678689-54bf-4214-ae4a-43082761afc5",
      "BillPaymentItemID": "98d52e7b-a95d-41d2-aded-be0357db5ad3",
      "AccountNumber": "sample string 3",
      "Reference": "sample string 4",
      "PayBillAmountEachBillFormatted": "sample string 5",
      "BillItemPending": true,
      "BillItemProcessed": true,
      "TransactionDateTime": "sample string 8"
    }
  ],
  "BillPaymentComplete": true,
  "BillMessage": "sample string 2",
  "BillItemComplete": {
    "BillPaymentID": "d9678689-54bf-4214-ae4a-43082761afc5",
    "BillPaymentItemID": "98d52e7b-a95d-41d2-aded-be0357db5ad3",
    "AccountNumber": "sample string 3",
    "Reference": "sample string 4",
    "PayBillAmountEachBillFormatted": "sample string 5",
    "BillItemPending": true,
    "BillItemProcessed": true,
    "TransactionDateTime": "sample string 8"
  },
  "Success": true,
  "ErrorMessage": "sample string 4",
  "ServerDateTime": "sample string 5",
  "ErrorType": 0
}

application/xml, text/xml

Sample:

<GetBillPaymentProgressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <ErrorMessage>sample string 4</ErrorMessage>
  <ErrorType>SystemError</ErrorType>
  <ServerDateTime>sample string 5</ServerDateTime>
  <Success>true</Success>
  <BillItemComplete>
    <AccountNumber>sample string 3</AccountNumber>
    <BillItemPending>true</BillItemPending>
    <BillItemProcessed>true</BillItemProcessed>
    <BillPaymentID>d9678689-54bf-4214-ae4a-43082761afc5</BillPaymentID>
    <BillPaymentItemID>98d52e7b-a95d-41d2-aded-be0357db5ad3</BillPaymentItemID>
    <PayBillAmountEachBillFormatted>sample string 5</PayBillAmountEachBillFormatted>
    <Reference>sample string 4</Reference>
    <TransactionDateTime>sample string 8</TransactionDateTime>
  </BillItemComplete>
  <BillMessage>sample string 2</BillMessage>
  <BillPaymentComplete>true</BillPaymentComplete>
  <PayBillComplete>
    <PayBillComplete>
      <AccountNumber>sample string 3</AccountNumber>
      <BillItemPending>true</BillItemPending>
      <BillItemProcessed>true</BillItemProcessed>
      <BillPaymentID>d9678689-54bf-4214-ae4a-43082761afc5</BillPaymentID>
      <BillPaymentItemID>98d52e7b-a95d-41d2-aded-be0357db5ad3</BillPaymentItemID>
      <PayBillAmountEachBillFormatted>sample string 5</PayBillAmountEachBillFormatted>
      <Reference>sample string 4</Reference>
      <TransactionDateTime>sample string 8</TransactionDateTime>
    </PayBillComplete>
    <PayBillComplete>
      <AccountNumber>sample string 3</AccountNumber>
      <BillItemPending>true</BillItemPending>
      <BillItemProcessed>true</BillItemProcessed>
      <BillPaymentID>d9678689-54bf-4214-ae4a-43082761afc5</BillPaymentID>
      <BillPaymentItemID>98d52e7b-a95d-41d2-aded-be0357db5ad3</BillPaymentItemID>
      <PayBillAmountEachBillFormatted>sample string 5</PayBillAmountEachBillFormatted>
      <Reference>sample string 4</Reference>
      <TransactionDateTime>sample string 8</TransactionDateTime>
    </PayBillComplete>
  </PayBillComplete>
</GetBillPaymentProgressResponse>