POST Api/Vending/AccountCharges

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerReferenceNumber	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:

{
  "CustomerReferenceNumber": "sample string 1",
  "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:

<AccountChargesRequest 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>
  <CustomerReferenceNumber>sample string 1</CustomerReferenceNumber>
</AccountChargesRequest>

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

Response Information

Resource Description

AccountChargesResponse

Name	Type	Additional information
ChargesViewModel	Collection of ChargesViewModel	None.
CustomerDetails	CustomerDetail	None.
CustomerConfig	CustomerConfig	None.
PaymentTypes	Collection of PaymentTypesModel	None.
PaymentPercentageFees	Collection of PaymentPercentageFees	None.
RecentCreditVend	RecentCreditVendModel	None.
Success	boolean	None.
ErrorMessage	string	None.
ServerDateTime	string	None.
ErrorType	Errors	None.

Response Formats

application/json, text/json

Sample:

{
  "ChargesViewModel": [
    {
      "Comments": "",
      "Charge": {
        "LinkedAccountNo": "sample string 1",
        "Description": "sample string 2",
        "Balance": 3.0,
        "MinimumDue": 4.0,
        "DueDate": "2026-05-17T03:30:08.9225041+02:00",
        "NextTxMinAmountDue": 6.0,
        "AmountToPay": 7.0,
        "LinkedAccountUniqueID": "f017b994-8719-4d1d-98e3-75f14210c200",
        "MaxMonthlyElectPurchaseAmount": 9.0,
        "RecordTypeName": "sample string 10",
        "PrimaryAccountNo": "sample string 11",
        "PaymentMethod": "sample string 12"
      },
      "PurchaseAmt": 2.0,
      "ChargeType": ""
    },
    {
      "Comments": "",
      "Charge": {
        "LinkedAccountNo": "sample string 1",
        "Description": "sample string 2",
        "Balance": 3.0,
        "MinimumDue": 4.0,
        "DueDate": "2026-05-17T03:30:08.9225041+02:00",
        "NextTxMinAmountDue": 6.0,
        "AmountToPay": 7.0,
        "LinkedAccountUniqueID": "f017b994-8719-4d1d-98e3-75f14210c200",
        "MaxMonthlyElectPurchaseAmount": 9.0,
        "RecordTypeName": "sample string 10",
        "PrimaryAccountNo": "sample string 11",
        "PaymentMethod": "sample string 12"
      },
      "PurchaseAmt": 2.0,
      "ChargeType": ""
    }
  ],
  "CustomerDetails": {
    "AccountNumber": "sample string 1",
    "Name": "sample string 2",
    "Address": "sample string 3",
    "ContactNumber": "sample string 4"
  },
  "CustomerConfig": {
    "CanVend": true,
    "MinVendAmount": 2.0,
    "MaxVendAmount": 3.0
  },
  "PaymentTypes": [
    {
      "PaymentTypeID": 1,
      "PaymentType": "sample string 2"
    },
    {
      "PaymentTypeID": 1,
      "PaymentType": "sample string 2"
    }
  ],
  "PaymentPercentageFees": [
    {
      "PaymentTypeID": 1,
      "Percentage": 1.1
    },
    {
      "PaymentTypeID": 1,
      "Percentage": 1.1
    }
  ],
  "RecentCreditVend": {
    "RecentCreditVend": true,
    "RecentCreditVendAmount": 1.0,
    "RecentCreditVendStatus": "sample string 2"
  },
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ServerDateTime": "sample string 3",
  "ErrorType": 0
}

application/xml, text/xml

Sample:

<AccountChargesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <ErrorType>SystemError</ErrorType>
  <ServerDateTime>sample string 3</ServerDateTime>
  <Success>true</Success>
  <ChargesViewModel>
    <ChargesViewModel>
      <Charge>
        <AmountToPay>7</AmountToPay>
        <Balance>3</Balance>
        <Description>sample string 2</Description>
        <DueDate>2026-05-17T03:30:08.9225041+02:00</DueDate>
        <LinkedAccountNo>sample string 1</LinkedAccountNo>
        <LinkedAccountUniqueID>f017b994-8719-4d1d-98e3-75f14210c200</LinkedAccountUniqueID>
        <MaxMonthlyElectPurchaseAmount>9</MaxMonthlyElectPurchaseAmount>
        <MinimumDue>4</MinimumDue>
        <NextTxMinAmountDue>6</NextTxMinAmountDue>
        <PaymentMethod>sample string 12</PaymentMethod>
        <PrimaryAccountNo>sample string 11</PrimaryAccountNo>
        <RecordTypeName>sample string 10</RecordTypeName>
      </Charge>
      <Comments></Comments>
      <PurchaseAmt>2</PurchaseAmt>
    </ChargesViewModel>
    <ChargesViewModel>
      <Charge>
        <AmountToPay>7</AmountToPay>
        <Balance>3</Balance>
        <Description>sample string 2</Description>
        <DueDate>2026-05-17T03:30:08.9225041+02:00</DueDate>
        <LinkedAccountNo>sample string 1</LinkedAccountNo>
        <LinkedAccountUniqueID>f017b994-8719-4d1d-98e3-75f14210c200</LinkedAccountUniqueID>
        <MaxMonthlyElectPurchaseAmount>9</MaxMonthlyElectPurchaseAmount>
        <MinimumDue>4</MinimumDue>
        <NextTxMinAmountDue>6</NextTxMinAmountDue>
        <PaymentMethod>sample string 12</PaymentMethod>
        <PrimaryAccountNo>sample string 11</PrimaryAccountNo>
        <RecordTypeName>sample string 10</RecordTypeName>
      </Charge>
      <Comments></Comments>
      <PurchaseAmt>2</PurchaseAmt>
    </ChargesViewModel>
  </ChargesViewModel>
  <CustomerConfig>
    <CanVend>true</CanVend>
    <MaxVendAmount>3</MaxVendAmount>
    <MinVendAmount>2</MinVendAmount>
  </CustomerConfig>
  <CustomerDetails>
    <AccountNumber>sample string 1</AccountNumber>
    <Address>sample string 3</Address>
    <ContactNumber>sample string 4</ContactNumber>
    <Name>sample string 2</Name>
  </CustomerDetails>
  <PaymentPercentageFees>
    <PaymentPercentageFees>
      <PaymentTypeID>CreditCard</PaymentTypeID>
      <Percentage>1.1</Percentage>
    </PaymentPercentageFees>
    <PaymentPercentageFees>
      <PaymentTypeID>CreditCard</PaymentTypeID>
      <Percentage>1.1</Percentage>
    </PaymentPercentageFees>
  </PaymentPercentageFees>
  <PaymentTypes>
    <PaymentTypesModel>
      <PaymentType>sample string 2</PaymentType>
      <PaymentTypeID>1</PaymentTypeID>
    </PaymentTypesModel>
    <PaymentTypesModel>
      <PaymentType>sample string 2</PaymentType>
      <PaymentTypeID>1</PaymentTypeID>
    </PaymentTypesModel>
  </PaymentTypes>
  <RecentCreditVend>
    <RecentCreditVend>true</RecentCreditVend>
    <RecentCreditVendAmount>1</RecentCreditVendAmount>
    <RecentCreditVendStatus>sample string 2</RecentCreditVendStatus>
  </RecentCreditVend>
</AccountChargesResponse>