POST Api/Vending/PurchaseHistory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
NumberOfPurchases	integer	None.
NumberOfOrders	integer	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:

{
  "NumberOfPurchases": 1,
  "NumberOfOrders": 2,
  "Username": "sample string 3",
  "Password": "sample string 4",
  "DeviceManufacturer": "sample string 5",
  "DeviceModel": "sample string 6",
  "DeviceSDKInt": "sample string 7",
  "DeviceSDKVersion": "sample string 8"
}

application/xml, text/xml

Sample:

<PurchaseHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 5</DeviceManufacturer>
  <DeviceModel>sample string 6</DeviceModel>
  <DeviceSDKInt>sample string 7</DeviceSDKInt>
  <DeviceSDKVersion>sample string 8</DeviceSDKVersion>
  <Password>sample string 4</Password>
  <Username>sample string 3</Username>
  <NumberOfOrders>2</NumberOfOrders>
  <NumberOfPurchases>1</NumberOfPurchases>
</PurchaseHistoryRequest>

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

Response Information

Resource Description

PurchaseHistoryResponse

Name	Type	Additional information
PurchaseHistory	Collection of PerformCreditVendResponse	None.
PurchaseOrderHistory	Collection of PurchaseOrderHistory	None.
BillPaymentPurchaseHistory	Collection of BillPaymentPurchaseHistory	None.
BillPaymentInProgress	Collection of BillPaymentInProgress	None.
Success	boolean	None.
ErrorMessage	string	None.
ServerDateTime	string	None.
ErrorType	Errors	None.

Response Formats

application/json, text/json

Sample:

{
  "PurchaseHistory": [
    {
      "ReceiptData": {
        "Data": null
      },
      "ReceiptTokens": [
        {
          "TokenIndex": 1,
          "TokenDescription": "sample string 2",
          "Token": "sample string 3"
        },
        {
          "TokenIndex": 1,
          "TokenDescription": "sample string 2",
          "Token": "sample string 3"
        }
      ],
      "VendingResponseID": "6e2a5990-2284-4208-812a-eb81f802e056",
      "CustomerReferenceNumber": "sample string 2",
      "TransactionDateTime": "sample string 3",
      "TotalAmount": "sample string 4",
      "Success": true,
      "ErrorMessage": "sample string 6",
      "ServerDateTime": "sample string 7",
      "ErrorType": 0
    },
    {
      "ReceiptData": {
        "Data": null
      },
      "ReceiptTokens": [
        {
          "TokenIndex": 1,
          "TokenDescription": "sample string 2",
          "Token": "sample string 3"
        },
        {
          "TokenIndex": 1,
          "TokenDescription": "sample string 2",
          "Token": "sample string 3"
        }
      ],
      "VendingResponseID": "6e2a5990-2284-4208-812a-eb81f802e056",
      "CustomerReferenceNumber": "sample string 2",
      "TransactionDateTime": "sample string 3",
      "TotalAmount": "sample string 4",
      "Success": true,
      "ErrorMessage": "sample string 6",
      "ServerDateTime": "sample string 7",
      "ErrorType": 0
    }
  ],
  "PurchaseOrderHistory": [
    {
      "CustomerReferenceNumber": "sample string 1",
      "CustomerReference": "sample string 2",
      "TotalAmount": 3.0,
      "TransactionDateTime": "sample string 4",
      "Status": "sample string 5",
      "Message": "sample string 6",
      "InProgress": true
    },
    {
      "CustomerReferenceNumber": "sample string 1",
      "CustomerReference": "sample string 2",
      "TotalAmount": 3.0,
      "TransactionDateTime": "sample string 4",
      "Status": "sample string 5",
      "Message": "sample string 6",
      "InProgress": true
    }
  ],
  "BillPaymentPurchaseHistory": [
    {
      "BillPaymentID": "adc656f7-cbd6-454a-8eb5-5384c918855b",
      "MasterReceiptNumber": "sample string 2",
      "TransactionDateTime": "sample string 3",
      "TotalAmount": "sample string 4",
      "BillPaymentItems": [
        {
          "BillPaymentID": "b54372c8-de4f-4d48-8cf9-c3ea802a0c18",
          "BillPaymentItemID": "26a3291d-b4c9-4839-825a-91349eb5cb9b",
          "AccountNumber": "sample string 3",
          "Reference": "sample string 4",
          "PayBillAmountEachBillFormatted": "sample string 5",
          "BillItemPending": true,
          "BillItemProcessed": true,
          "TransactionDateTime": "sample string 8"
        },
        {
          "BillPaymentID": "b54372c8-de4f-4d48-8cf9-c3ea802a0c18",
          "BillPaymentItemID": "26a3291d-b4c9-4839-825a-91349eb5cb9b",
          "AccountNumber": "sample string 3",
          "Reference": "sample string 4",
          "PayBillAmountEachBillFormatted": "sample string 5",
          "BillItemPending": true,
          "BillItemProcessed": true,
          "TransactionDateTime": "sample string 8"
        }
      ],
      "BillPaymentItemsProcessed": true,
      "BillPaymentItemsPartiallyProcessed": true
    },
    {
      "BillPaymentID": "adc656f7-cbd6-454a-8eb5-5384c918855b",
      "MasterReceiptNumber": "sample string 2",
      "TransactionDateTime": "sample string 3",
      "TotalAmount": "sample string 4",
      "BillPaymentItems": [
        {
          "BillPaymentID": "b54372c8-de4f-4d48-8cf9-c3ea802a0c18",
          "BillPaymentItemID": "26a3291d-b4c9-4839-825a-91349eb5cb9b",
          "AccountNumber": "sample string 3",
          "Reference": "sample string 4",
          "PayBillAmountEachBillFormatted": "sample string 5",
          "BillItemPending": true,
          "BillItemProcessed": true,
          "TransactionDateTime": "sample string 8"
        },
        {
          "BillPaymentID": "b54372c8-de4f-4d48-8cf9-c3ea802a0c18",
          "BillPaymentItemID": "26a3291d-b4c9-4839-825a-91349eb5cb9b",
          "AccountNumber": "sample string 3",
          "Reference": "sample string 4",
          "PayBillAmountEachBillFormatted": "sample string 5",
          "BillItemPending": true,
          "BillItemProcessed": true,
          "TransactionDateTime": "sample string 8"
        }
      ],
      "BillPaymentItemsProcessed": true,
      "BillPaymentItemsPartiallyProcessed": true
    }
  ],
  "BillPaymentInProgress": [
    {
      "BillPaymentID": "210f5855-0071-41d4-a14e-acabc48aa688",
      "PaymentReference": "sample string 2",
      "TransactionDateTime": "sample string 3",
      "BillItemCount": "sample string 4",
      "TotalAmount": "sample string 5"
    },
    {
      "BillPaymentID": "210f5855-0071-41d4-a14e-acabc48aa688",
      "PaymentReference": "sample string 2",
      "TransactionDateTime": "sample string 3",
      "BillItemCount": "sample string 4",
      "TotalAmount": "sample string 5"
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ServerDateTime": "sample string 3",
  "ErrorType": 0
}

application/xml, text/xml

Sample:

<PurchaseHistoryResponse 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>
  <BillPaymentInProgress>
    <BillPaymentInProgress>
      <BillItemCount>sample string 4</BillItemCount>
      <BillPaymentID>210f5855-0071-41d4-a14e-acabc48aa688</BillPaymentID>
      <PaymentReference>sample string 2</PaymentReference>
      <TotalAmount>sample string 5</TotalAmount>
      <TransactionDateTime>sample string 3</TransactionDateTime>
    </BillPaymentInProgress>
    <BillPaymentInProgress>
      <BillItemCount>sample string 4</BillItemCount>
      <BillPaymentID>210f5855-0071-41d4-a14e-acabc48aa688</BillPaymentID>
      <PaymentReference>sample string 2</PaymentReference>
      <TotalAmount>sample string 5</TotalAmount>
      <TransactionDateTime>sample string 3</TransactionDateTime>
    </BillPaymentInProgress>
  </BillPaymentInProgress>
  <BillPaymentPurchaseHistory>
    <BillPaymentPurchaseHistory>
      <BillPaymentID>adc656f7-cbd6-454a-8eb5-5384c918855b</BillPaymentID>
      <BillPaymentItems>
        <PayBillComplete>
          <AccountNumber>sample string 3</AccountNumber>
          <BillItemPending>true</BillItemPending>
          <BillItemProcessed>true</BillItemProcessed>
          <BillPaymentID>b54372c8-de4f-4d48-8cf9-c3ea802a0c18</BillPaymentID>
          <BillPaymentItemID>26a3291d-b4c9-4839-825a-91349eb5cb9b</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>b54372c8-de4f-4d48-8cf9-c3ea802a0c18</BillPaymentID>
          <BillPaymentItemID>26a3291d-b4c9-4839-825a-91349eb5cb9b</BillPaymentItemID>
          <PayBillAmountEachBillFormatted>sample string 5</PayBillAmountEachBillFormatted>
          <Reference>sample string 4</Reference>
          <TransactionDateTime>sample string 8</TransactionDateTime>
        </PayBillComplete>
      </BillPaymentItems>
      <BillPaymentItemsPartiallyProcessed>true</BillPaymentItemsPartiallyProcessed>
      <BillPaymentItemsProcessed>true</BillPaymentItemsProcessed>
      <MasterReceiptNumber>sample string 2</MasterReceiptNumber>
      <TotalAmount>sample string 4</TotalAmount>
      <TransactionDateTime>sample string 3</TransactionDateTime>
    </BillPaymentPurchaseHistory>
    <BillPaymentPurchaseHistory>
      <BillPaymentID>adc656f7-cbd6-454a-8eb5-5384c918855b</BillPaymentID>
      <BillPaymentItems>
        <PayBillComplete>
          <AccountNumber>sample string 3</AccountNumber>
          <BillItemPending>true</BillItemPending>
          <BillItemProcessed>true</BillItemProcessed>
          <BillPaymentID>b54372c8-de4f-4d48-8cf9-c3ea802a0c18</BillPaymentID>
          <BillPaymentItemID>26a3291d-b4c9-4839-825a-91349eb5cb9b</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>b54372c8-de4f-4d48-8cf9-c3ea802a0c18</BillPaymentID>
          <BillPaymentItemID>26a3291d-b4c9-4839-825a-91349eb5cb9b</BillPaymentItemID>
          <PayBillAmountEachBillFormatted>sample string 5</PayBillAmountEachBillFormatted>
          <Reference>sample string 4</Reference>
          <TransactionDateTime>sample string 8</TransactionDateTime>
        </PayBillComplete>
      </BillPaymentItems>
      <BillPaymentItemsPartiallyProcessed>true</BillPaymentItemsPartiallyProcessed>
      <BillPaymentItemsProcessed>true</BillPaymentItemsProcessed>
      <MasterReceiptNumber>sample string 2</MasterReceiptNumber>
      <TotalAmount>sample string 4</TotalAmount>
      <TransactionDateTime>sample string 3</TransactionDateTime>
    </BillPaymentPurchaseHistory>
  </BillPaymentPurchaseHistory>
  <PurchaseHistory>
    <PerformCreditVendResponse>
      <ErrorMessage>sample string 6</ErrorMessage>
      <ErrorType>SystemError</ErrorType>
      <ServerDateTime>sample string 7</ServerDateTime>
      <Success>true</Success>
      <CustomerReferenceNumber>sample string 2</CustomerReferenceNumber>
      <ReceiptData xmlns:d4p1="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Helpers">
        <d4p1:Data i:nil="true" />
      </ReceiptData>
      <ReceiptTokens>
        <ReceiptTokens>
          <Token>sample string 3</Token>
          <TokenDescription>sample string 2</TokenDescription>
          <TokenIndex>1</TokenIndex>
        </ReceiptTokens>
        <ReceiptTokens>
          <Token>sample string 3</Token>
          <TokenDescription>sample string 2</TokenDescription>
          <TokenIndex>1</TokenIndex>
        </ReceiptTokens>
      </ReceiptTokens>
      <TotalAmount>sample string 4</TotalAmount>
      <TransactionDateTime>sample string 3</TransactionDateTime>
      <VendingResponseID>6e2a5990-2284-4208-812a-eb81f802e056</VendingResponseID>
    </PerformCreditVendResponse>
    <PerformCreditVendResponse>
      <ErrorMessage>sample string 6</ErrorMessage>
      <ErrorType>SystemError</ErrorType>
      <ServerDateTime>sample string 7</ServerDateTime>
      <Success>true</Success>
      <CustomerReferenceNumber>sample string 2</CustomerReferenceNumber>
      <ReceiptData xmlns:d4p1="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Helpers">
        <d4p1:Data i:nil="true" />
      </ReceiptData>
      <ReceiptTokens>
        <ReceiptTokens>
          <Token>sample string 3</Token>
          <TokenDescription>sample string 2</TokenDescription>
          <TokenIndex>1</TokenIndex>
        </ReceiptTokens>
        <ReceiptTokens>
          <Token>sample string 3</Token>
          <TokenDescription>sample string 2</TokenDescription>
          <TokenIndex>1</TokenIndex>
        </ReceiptTokens>
      </ReceiptTokens>
      <TotalAmount>sample string 4</TotalAmount>
      <TransactionDateTime>sample string 3</TransactionDateTime>
      <VendingResponseID>6e2a5990-2284-4208-812a-eb81f802e056</VendingResponseID>
    </PerformCreditVendResponse>
  </PurchaseHistory>
  <PurchaseOrderHistory>
    <PurchaseOrderHistory>
      <CustomerReference>sample string 2</CustomerReference>
      <CustomerReferenceNumber>sample string 1</CustomerReferenceNumber>
      <InProgress>true</InProgress>
      <Message>sample string 6</Message>
      <Status>sample string 5</Status>
      <TotalAmount>3</TotalAmount>
      <TransactionDateTime>sample string 4</TransactionDateTime>
    </PurchaseOrderHistory>
    <PurchaseOrderHistory>
      <CustomerReference>sample string 2</CustomerReference>
      <CustomerReferenceNumber>sample string 1</CustomerReferenceNumber>
      <InProgress>true</InProgress>
      <Message>sample string 6</Message>
      <Status>sample string 5</Status>
      <TotalAmount>3</TotalAmount>
      <TransactionDateTime>sample string 4</TransactionDateTime>
    </PurchaseOrderHistory>
  </PurchaseOrderHistory>
</PurchaseHistoryResponse>