Cash Register Methods of Payments Conexxus 3.5 PULL API

GET /{stationId}/mop/files

API endpoint returns methods of payments (MOPs) dataset, available on a particular cash register. Methods of payments dataset mapped to the Conexxus 3.5 standard.

Detailed API description is provided by Petrosoft Swagger according to OpenAPI Specification.

Example of XML Document returned by API

The example below is taken from the testing environment with testing data. No association with any real company, product, event, or data is intended or should be inferred.

XML Example with MSM Data


<?xml version="1.0"?>
<NAXML-MovementReport xmlns="http://www.naxml.org/POSBO/Vocabulary/2003-10-16" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="3.5" xsi:schemaLocation="http://www.naxml.org/POSBO/Vocabulary/2003-10-16 NAXML-PBIMovement.xsd">
  <TransmissionHeader>
    <StoreLocationID>1179</StoreLocationID>
    <VendorName>CStoreOffice</VendorName>
    <VendorModelVersion>NAXML3.4.5</VendorModelVersion>
  </TransmissionHeader>
  <MiscellaneousSummaryMovement>
    <MovementHeader>
      <ReportSequenceNumber>0</ReportSequenceNumber>
      <PrimaryReportPeriod/>
      <BeginDate>1900-01-01</BeginDate>
      <BeginTime>00:00:00</BeginTime>
      <EndDate>1900-01-01</EndDate>
      <EndTime>00:00:00</EndTime>
    </MovementHeader>
    <SalesMovementHeader/>
    <MSMDetail>
      <MiscellaneousSummaryCodes>
        <MiscellaneousSummaryCode/>
      </MiscellaneousSummaryCodes>
      <MSMSalesTotals>
        <Tender>
          <TenderCode>CASH</TenderCode>
          <TenderSubCode>1</TenderSubCode>
        </Tender>
        <TenderTransactionsCount>1</TenderTransactionsCount>
        <MiscellaneousSummaryAmount>0.00000</MiscellaneousSummaryAmount>
      </MSMSalesTotals>
    </MSMDetail>
    <MSMDetail>
      <MiscellaneousSummaryCodes>
        <MiscellaneousSummaryCode/>
      </MiscellaneousSummaryCodes>
      <MSMSalesTotals>
        <Tender>
          <TenderCode>CHECK</TenderCode>
          <TenderSubCode>2</TenderSubCode>
        </Tender>
        <TenderTransactionsCount>0</TenderTransactionsCount>
        <MiscellaneousSummaryAmount>0.00000</MiscellaneousSummaryAmount>
      </MSMSalesTotals>
    </MSMDetail>
    <MSMDetail>
      <MiscellaneousSummaryCodes>
        <MiscellaneousSummaryCode/>
      </MiscellaneousSummaryCodes>
      <MSMSalesTotals>
        <Tender>
          <TenderCode>CREDIT</TenderCode>
          <TenderSubCode>3</TenderSubCode>
        </Tender>
        <TenderTransactionsCount>0</TenderTransactionsCount>
        <MiscellaneousSummaryAmount>0.00000</MiscellaneousSummaryAmount>
      </MSMSalesTotals>
    </MSMDetail>
    <MSMDetail>
      <MiscellaneousSummaryCodes>
        <MiscellaneousSummaryCode/>
      </MiscellaneousSummaryCodes>
      <MSMSalesTotals>
        <Tender>
          <TenderCode>DEBIT</TenderCode>
          <TenderSubCode>4</TenderSubCode>
        </Tender>
        <TenderTransactionsCount>0</TenderTransactionsCount>
        <MiscellaneousSummaryAmount>0.00000</MiscellaneousSummaryAmount>
      </MSMSalesTotals>
    </MSMDetail>
    <MSMDetail>
      <MiscellaneousSummaryCodes>
        <MiscellaneousSummaryCode/>
      </MiscellaneousSummaryCodes>
      <MSMSalesTotals>
        <Tender>
          <TenderCode>MAN CRED</TenderCode>
          <TenderSubCode>5</TenderSubCode>
        </Tender>
        <TenderTransactionsCount>0</TenderTransactionsCount>
        <MiscellaneousSummaryAmount>0.00000</MiscellaneousSummaryAmount>
      </MSMSalesTotals>
    </MSMDetail>
    <MSMDetail>
      <MiscellaneousSummaryCodes>
        <MiscellaneousSummaryCode/>
      </MiscellaneousSummaryCodes>
      <MSMSalesTotals>
        <Tender>
          <TenderCode>IN-HOUSE</TenderCode>
          <TenderSubCode>6</TenderSubCode>
        </Tender>
        <TenderTransactionsCount>0</TenderTransactionsCount>
        <MiscellaneousSummaryAmount>0.00000</MiscellaneousSummaryAmount>
      </MSMSalesTotals>
    </MSMDetail>
    <MSMDetail>
      <MiscellaneousSummaryCodes>
        <MiscellaneousSummaryCode/>
      </MiscellaneousSummaryCodes>
      <MSMSalesTotals>
        <Tender>
          <TenderCode>FOODSTAMP</TenderCode>
          <TenderSubCode>8</TenderSubCode>
        </Tender>
        <TenderTransactionsCount>0</TenderTransactionsCount>
        <MiscellaneousSummaryAmount>0.00000</MiscellaneousSummaryAmount>
      </MSMSalesTotals>
    </MSMDetail>
  </MiscellaneousSummaryMovement>
</NAXML-MovementReport>

To download the example of the XML document returned by API, click here.