POST Api/BillPayments/ValidateBillPayment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OutstandingBillPaymentID	globally unique identifier	None.
BillPaymentID	globally unique identifier	None.
PayBillPaymentAccounts	Collection of PayBillAccounts	None.
PaymentTypeID	PaymentTypes	None.
CardContributionAmount	decimal number	None.
InstantEFTContributionAmount	decimal number	None.
WalletContributionAmount	decimal number	None.
PaymentReference	string	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:

{
  "OutstandingBillPaymentID": "319a5278-460a-47aa-8449-e5ea8147b7c3",
  "BillPaymentID": "0c13886b-0de4-48a1-83f9-ea85709da263",
  "PayBillPaymentAccounts": [
    {
      "AccountNumber": "sample string 1",
      "Reference": "sample string 2",
      "UtilityDescription": "sample string 3",
      "PaymentPercentageFees": [
        {
          "PaymentTypeID": 1,
          "Percentage": 1.1
        },
        {
          "PaymentTypeID": 1,
          "Percentage": 1.1
        }
      ],
      "PayBillAmountEachBill": 4.0,
      "strPayBillAmountEachBill": "sample string 5",
      "ReferralCode": "sample string 6",
      "BillPaymentID": "a0bc49a8-2a40-412f-a117-f46bb30fd53e",
      "BillPaymentItemID": "140417ab-c3f1-48b5-b9bf-11caa803380a"
    },
    {
      "AccountNumber": "sample string 1",
      "Reference": "sample string 2",
      "UtilityDescription": "sample string 3",
      "PaymentPercentageFees": [
        {
          "PaymentTypeID": 1,
          "Percentage": 1.1
        },
        {
          "PaymentTypeID": 1,
          "Percentage": 1.1
        }
      ],
      "PayBillAmountEachBill": 4.0,
      "strPayBillAmountEachBill": "sample string 5",
      "ReferralCode": "sample string 6",
      "BillPaymentID": "a0bc49a8-2a40-412f-a117-f46bb30fd53e",
      "BillPaymentItemID": "140417ab-c3f1-48b5-b9bf-11caa803380a"
    }
  ],
  "PaymentTypeID": 1,
  "CardContributionAmount": 2.0,
  "InstantEFTContributionAmount": 3.0,
  "WalletContributionAmount": 4.0,
  "PaymentReference": "sample string 5",
  "Username": "sample string 6",
  "Password": "sample string 7",
  "DeviceManufacturer": "sample string 8",
  "DeviceModel": "sample string 9",
  "DeviceSDKInt": "sample string 10",
  "DeviceSDKVersion": "sample string 11"
}

application/xml, text/xml

Sample:

<ValidateBillPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 8</DeviceManufacturer>
  <DeviceModel>sample string 9</DeviceModel>
  <DeviceSDKInt>sample string 10</DeviceSDKInt>
  <DeviceSDKVersion>sample string 11</DeviceSDKVersion>
  <Password>sample string 7</Password>
  <Username>sample string 6</Username>
  <BillPaymentID>0c13886b-0de4-48a1-83f9-ea85709da263</BillPaymentID>
  <CardContributionAmount>2</CardContributionAmount>
  <InstantEFTContributionAmount>3</InstantEFTContributionAmount>
  <PayBillPaymentAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Helpers">
    <d2p1:BillPaymentsHelper.PayBillAccounts>
      <d2p1:AccountNumber>sample string 1</d2p1:AccountNumber>
      <d2p1:BillPaymentID>a0bc49a8-2a40-412f-a117-f46bb30fd53e</d2p1:BillPaymentID>
      <d2p1:BillPaymentItemID>140417ab-c3f1-48b5-b9bf-11caa803380a</d2p1:BillPaymentItemID>
      <d2p1:PayBillAmountEachBill>4</d2p1:PayBillAmountEachBill>
      <d2p1:PaymentPercentageFees>
        <PaymentPercentageFees>
          <PaymentTypeID>CreditCard</PaymentTypeID>
          <Percentage>1.1</Percentage>
        </PaymentPercentageFees>
        <PaymentPercentageFees>
          <PaymentTypeID>CreditCard</PaymentTypeID>
          <Percentage>1.1</Percentage>
        </PaymentPercentageFees>
      </d2p1:PaymentPercentageFees>
      <d2p1:Reference>sample string 2</d2p1:Reference>
      <d2p1:ReferralCode>sample string 6</d2p1:ReferralCode>
      <d2p1:UtilityDescription>sample string 3</d2p1:UtilityDescription>
      <d2p1:strPayBillAmountEachBill>sample string 5</d2p1:strPayBillAmountEachBill>
    </d2p1:BillPaymentsHelper.PayBillAccounts>
    <d2p1:BillPaymentsHelper.PayBillAccounts>
      <d2p1:AccountNumber>sample string 1</d2p1:AccountNumber>
      <d2p1:BillPaymentID>a0bc49a8-2a40-412f-a117-f46bb30fd53e</d2p1:BillPaymentID>
      <d2p1:BillPaymentItemID>140417ab-c3f1-48b5-b9bf-11caa803380a</d2p1:BillPaymentItemID>
      <d2p1:PayBillAmountEachBill>4</d2p1:PayBillAmountEachBill>
      <d2p1:PaymentPercentageFees>
        <PaymentPercentageFees>
          <PaymentTypeID>CreditCard</PaymentTypeID>
          <Percentage>1.1</Percentage>
        </PaymentPercentageFees>
        <PaymentPercentageFees>
          <PaymentTypeID>CreditCard</PaymentTypeID>
          <Percentage>1.1</Percentage>
        </PaymentPercentageFees>
      </d2p1:PaymentPercentageFees>
      <d2p1:Reference>sample string 2</d2p1:Reference>
      <d2p1:ReferralCode>sample string 6</d2p1:ReferralCode>
      <d2p1:UtilityDescription>sample string 3</d2p1:UtilityDescription>
      <d2p1:strPayBillAmountEachBill>sample string 5</d2p1:strPayBillAmountEachBill>
    </d2p1:BillPaymentsHelper.PayBillAccounts>
  </PayBillPaymentAccounts>
  <PaymentReference>sample string 5</PaymentReference>
  <PaymentTypeID>CreditCard</PaymentTypeID>
  <WalletContributionAmount>4</WalletContributionAmount>
  <OutstandingBillPaymentID>319a5278-460a-47aa-8449-e5ea8147b7c3</OutstandingBillPaymentID>
</ValidateBillPaymentRequest>

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 'ValidateBillPaymentRequest'.

Response Information

Resource Description

ValidateBillPaymentResponse

Name	Type	Additional information
BillPaymentID	globally unique identifier	None.
PaymentReference	string	None.
OutstandingBillPayment	PayMultipleBillsRequest	None.
Success	boolean	None.
ErrorMessage	string	None.
ServerDateTime	string	None.
ErrorType	Errors	None.

Response Formats

application/json, text/json

Sample:

{
  "BillPaymentID": "d2b61b5a-90ca-4763-8e20-988d2b96c701",
  "PaymentReference": "sample string 2",
  "OutstandingBillPayment": {
    "BillPaymentID": "2c242794-8bcd-4874-98f8-044e10192de8",
    "PayBillPaymentAccounts": [
      {
        "AccountNumber": "sample string 1",
        "Reference": "sample string 2",
        "UtilityDescription": "sample string 3",
        "PaymentPercentageFees": [
          {
            "PaymentTypeID": 1,
            "Percentage": 1.1
          },
          {
            "PaymentTypeID": 1,
            "Percentage": 1.1
          }
        ],
        "PayBillAmountEachBill": 4.0,
        "strPayBillAmountEachBill": "sample string 5",
        "ReferralCode": "sample string 6",
        "BillPaymentID": "72b04551-51ed-4053-9b24-cb64594ce9e1",
        "BillPaymentItemID": "72dfdf25-48df-4115-bb5d-04408398515f"
      },
      {
        "AccountNumber": "sample string 1",
        "Reference": "sample string 2",
        "UtilityDescription": "sample string 3",
        "PaymentPercentageFees": [
          {
            "PaymentTypeID": 1,
            "Percentage": 1.1
          },
          {
            "PaymentTypeID": 1,
            "Percentage": 1.1
          }
        ],
        "PayBillAmountEachBill": 4.0,
        "strPayBillAmountEachBill": "sample string 5",
        "ReferralCode": "sample string 6",
        "BillPaymentID": "72b04551-51ed-4053-9b24-cb64594ce9e1",
        "BillPaymentItemID": "72dfdf25-48df-4115-bb5d-04408398515f"
      }
    ],
    "PaymentTypeID": 1,
    "CardContributionAmount": 2.0,
    "InstantEFTContributionAmount": 3.0,
    "WalletContributionAmount": 4.0,
    "PaymentReference": "sample string 5",
    "Username": "sample string 6",
    "Password": "sample string 7",
    "DeviceManufacturer": "sample string 8",
    "DeviceModel": "sample string 9",
    "DeviceSDKInt": "sample string 10",
    "DeviceSDKVersion": "sample string 11"
  },
  "Success": true,
  "ErrorMessage": "sample string 4",
  "ServerDateTime": "sample string 5",
  "ErrorType": 0
}

application/xml, text/xml

Sample:

<ValidateBillPaymentResponse 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>
  <BillPaymentID>d2b61b5a-90ca-4763-8e20-988d2b96c701</BillPaymentID>
  <OutstandingBillPayment>
    <DeviceManufacturer>sample string 8</DeviceManufacturer>
    <DeviceModel>sample string 9</DeviceModel>
    <DeviceSDKInt>sample string 10</DeviceSDKInt>
    <DeviceSDKVersion>sample string 11</DeviceSDKVersion>
    <Password>sample string 7</Password>
    <Username>sample string 6</Username>
    <BillPaymentID>2c242794-8bcd-4874-98f8-044e10192de8</BillPaymentID>
    <CardContributionAmount>2</CardContributionAmount>
    <InstantEFTContributionAmount>3</InstantEFTContributionAmount>
    <PayBillPaymentAccounts xmlns:d3p1="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Helpers">
      <d3p1:BillPaymentsHelper.PayBillAccounts>
        <d3p1:AccountNumber>sample string 1</d3p1:AccountNumber>
        <d3p1:BillPaymentID>72b04551-51ed-4053-9b24-cb64594ce9e1</d3p1:BillPaymentID>
        <d3p1:BillPaymentItemID>72dfdf25-48df-4115-bb5d-04408398515f</d3p1:BillPaymentItemID>
        <d3p1:PayBillAmountEachBill>4</d3p1:PayBillAmountEachBill>
        <d3p1:PaymentPercentageFees>
          <PaymentPercentageFees>
            <PaymentTypeID>CreditCard</PaymentTypeID>
            <Percentage>1.1</Percentage>
          </PaymentPercentageFees>
          <PaymentPercentageFees>
            <PaymentTypeID>CreditCard</PaymentTypeID>
            <Percentage>1.1</Percentage>
          </PaymentPercentageFees>
        </d3p1:PaymentPercentageFees>
        <d3p1:Reference>sample string 2</d3p1:Reference>
        <d3p1:ReferralCode>sample string 6</d3p1:ReferralCode>
        <d3p1:UtilityDescription>sample string 3</d3p1:UtilityDescription>
        <d3p1:strPayBillAmountEachBill>sample string 5</d3p1:strPayBillAmountEachBill>
      </d3p1:BillPaymentsHelper.PayBillAccounts>
      <d3p1:BillPaymentsHelper.PayBillAccounts>
        <d3p1:AccountNumber>sample string 1</d3p1:AccountNumber>
        <d3p1:BillPaymentID>72b04551-51ed-4053-9b24-cb64594ce9e1</d3p1:BillPaymentID>
        <d3p1:BillPaymentItemID>72dfdf25-48df-4115-bb5d-04408398515f</d3p1:BillPaymentItemID>
        <d3p1:PayBillAmountEachBill>4</d3p1:PayBillAmountEachBill>
        <d3p1:PaymentPercentageFees>
          <PaymentPercentageFees>
            <PaymentTypeID>CreditCard</PaymentTypeID>
            <Percentage>1.1</Percentage>
          </PaymentPercentageFees>
          <PaymentPercentageFees>
            <PaymentTypeID>CreditCard</PaymentTypeID>
            <Percentage>1.1</Percentage>
          </PaymentPercentageFees>
        </d3p1:PaymentPercentageFees>
        <d3p1:Reference>sample string 2</d3p1:Reference>
        <d3p1:ReferralCode>sample string 6</d3p1:ReferralCode>
        <d3p1:UtilityDescription>sample string 3</d3p1:UtilityDescription>
        <d3p1:strPayBillAmountEachBill>sample string 5</d3p1:strPayBillAmountEachBill>
      </d3p1:BillPaymentsHelper.PayBillAccounts>
    </PayBillPaymentAccounts>
    <PaymentReference>sample string 5</PaymentReference>
    <PaymentTypeID>CreditCard</PaymentTypeID>
    <WalletContributionAmount>4</WalletContributionAmount>
  </OutstandingBillPayment>
  <PaymentReference>sample string 2</PaymentReference>
</ValidateBillPaymentResponse>