PaymentService Web Service

PaymentService

Click here for a complete list of operations.

PaymentSave

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /RoseComServicesTest/RoseCommServiceV3/APIV1/PaymentService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/PaymentSave"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <PaymentSave xmlns="http://tempuri.org/">
      <pPayment>
        <PaymentDate>dateTime</PaymentDate>
        <PaymentMethod>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PaymentMethod>
        <Amount>decimal</Amount>
        <PaymentReference>string</PaymentReference>
        <Currency>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Currency>
        <ExchangeRate>decimal</ExchangeRate>
        <IsRefund>boolean</IsRefund>
        <ExternalReference>string</ExternalReference>
        <SaleOrderID>int</SaleOrderID>
        <Site>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Site>
        <PaymentType>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PaymentType>
        <Comment>string</Comment>
        <PaymentLedgerType>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PaymentLedgerType>
        <IsDeposit>boolean</IsDeposit>
        <ShiftID>int</ShiftID>
        <WorkstationID>int</WorkstationID>
        <PaymentCardInfo>
          <CardTypeID>int</CardTypeID>
          <CardNumber>string</CardNumber>
          <HoldersName>string</HoldersName>
          <StartDate>dateTime</StartDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <IssueNumber>string</IssueNumber>
          <SecurityCode>string</SecurityCode>
          <AuthCode>string</AuthCode>
          <SalestarUniqueKey>string</SalestarUniqueKey>
          <PaymentTransactionID>string</PaymentTransactionID>
          <bCardManualAuthentication>boolean</bCardManualAuthentication>
        </PaymentCardInfo>
        <PaymentVoucherInfo>
          <TrackableItemID>long</TrackableItemID>
          <VoucherAmount>decimal</VoucherAmount>
          <PaidAmount>decimal</PaidAmount>
          <ExpiryDate>dateTime</ExpiryDate>
          <VoucherRef>string</VoucherRef>
        </PaymentVoucherInfo>
        <PaymentAllocations>
          <PaymentAllocation>
            <AllocationDate>dateTime</AllocationDate>
            <Site xsi:nil="true" />
            <EmployeeID>long</EmployeeID>
            <AmountAllocatedFrom>decimal</AmountAllocatedFrom>
            <AmountAllocatedTo>decimal</AmountAllocatedTo>
            <InvoiceID>long</InvoiceID>
            <Customer xsi:nil="true" />
            <LedgerType xsi:nil="true" />
          </PaymentAllocation>
          <PaymentAllocation>
            <AllocationDate>dateTime</AllocationDate>
            <Site xsi:nil="true" />
            <EmployeeID>long</EmployeeID>
            <AmountAllocatedFrom>decimal</AmountAllocatedFrom>
            <AmountAllocatedTo>decimal</AmountAllocatedTo>
            <InvoiceID>long</InvoiceID>
            <Customer xsi:nil="true" />
            <LedgerType xsi:nil="true" />
          </PaymentAllocation>
        </PaymentAllocations>
        <Location>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Location>
        <Application>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Application>
        <AuthCode>string</AuthCode>
        <AvailableToSpend>decimal</AvailableToSpend>
        <ExternalRef>string</ExternalRef>
        <LangCode>string</LangCode>
        <AccountBalance>decimal</AccountBalance>
        <CompanyName>string</CompanyName>
        <CompanyAddress>string</CompanyAddress>
        <SiteName>string</SiteName>
        <TotalAmountAllocated>decimal</TotalAmountAllocated>
      </pPayment>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </PaymentSave>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <PaymentSaveResponse xmlns="http://tempuri.org/">
      <PaymentSaveResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Payment>
            <PaymentDate>dateTime</PaymentDate>
            <PaymentMethod xsi:nil="true" />
            <Amount>decimal</Amount>
            <PaymentReference>string</PaymentReference>
            <Currency xsi:nil="true" />
            <ExchangeRate>decimal</ExchangeRate>
            <IsRefund>boolean</IsRefund>
            <ExternalReference>string</ExternalReference>
            <SaleOrderID>int</SaleOrderID>
            <Site xsi:nil="true" />
            <PaymentType xsi:nil="true" />
            <Comment>string</Comment>
            <PaymentLedgerType xsi:nil="true" />
            <IsDeposit>boolean</IsDeposit>
            <ShiftID>int</ShiftID>
            <WorkstationID>int</WorkstationID>
            <PaymentCardInfo xsi:nil="true" />
            <PaymentVoucherInfo xsi:nil="true" />
            <PaymentAllocations xsi:nil="true" />
            <Location xsi:nil="true" />
            <Application xsi:nil="true" />
            <AuthCode>string</AuthCode>
            <AvailableToSpend>decimal</AvailableToSpend>
            <ExternalRef>string</ExternalRef>
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <CompanyName>string</CompanyName>
            <CompanyAddress>string</CompanyAddress>
            <SiteName>string</SiteName>
            <TotalAmountAllocated>decimal</TotalAmountAllocated>
          </Payment>
          <Payment>
            <PaymentDate>dateTime</PaymentDate>
            <PaymentMethod xsi:nil="true" />
            <Amount>decimal</Amount>
            <PaymentReference>string</PaymentReference>
            <Currency xsi:nil="true" />
            <ExchangeRate>decimal</ExchangeRate>
            <IsRefund>boolean</IsRefund>
            <ExternalReference>string</ExternalReference>
            <SaleOrderID>int</SaleOrderID>
            <Site xsi:nil="true" />
            <PaymentType xsi:nil="true" />
            <Comment>string</Comment>
            <PaymentLedgerType xsi:nil="true" />
            <IsDeposit>boolean</IsDeposit>
            <ShiftID>int</ShiftID>
            <WorkstationID>int</WorkstationID>
            <PaymentCardInfo xsi:nil="true" />
            <PaymentVoucherInfo xsi:nil="true" />
            <PaymentAllocations xsi:nil="true" />
            <Location xsi:nil="true" />
            <Application xsi:nil="true" />
            <AuthCode>string</AuthCode>
            <AvailableToSpend>decimal</AvailableToSpend>
            <ExternalRef>string</ExternalRef>
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <CompanyName>string</CompanyName>
            <CompanyAddress>string</CompanyAddress>
            <SiteName>string</SiteName>
            <TotalAmountAllocated>decimal</TotalAmountAllocated>
          </Payment>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </PaymentSaveResult>
    </PaymentSaveResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /RoseComServicesTest/RoseCommServiceV3/APIV1/PaymentService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <PaymentSave xmlns="http://tempuri.org/">
      <pPayment>
        <PaymentDate>dateTime</PaymentDate>
        <PaymentMethod>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PaymentMethod>
        <Amount>decimal</Amount>
        <PaymentReference>string</PaymentReference>
        <Currency>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Currency>
        <ExchangeRate>decimal</ExchangeRate>
        <IsRefund>boolean</IsRefund>
        <ExternalReference>string</ExternalReference>
        <SaleOrderID>int</SaleOrderID>
        <Site>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Site>
        <PaymentType>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PaymentType>
        <Comment>string</Comment>
        <PaymentLedgerType>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </PaymentLedgerType>
        <IsDeposit>boolean</IsDeposit>
        <ShiftID>int</ShiftID>
        <WorkstationID>int</WorkstationID>
        <PaymentCardInfo>
          <CardTypeID>int</CardTypeID>
          <CardNumber>string</CardNumber>
          <HoldersName>string</HoldersName>
          <StartDate>dateTime</StartDate>
          <ExpiryDate>dateTime</ExpiryDate>
          <IssueNumber>string</IssueNumber>
          <SecurityCode>string</SecurityCode>
          <AuthCode>string</AuthCode>
          <SalestarUniqueKey>string</SalestarUniqueKey>
          <PaymentTransactionID>string</PaymentTransactionID>
          <bCardManualAuthentication>boolean</bCardManualAuthentication>
        </PaymentCardInfo>
        <PaymentVoucherInfo>
          <TrackableItemID>long</TrackableItemID>
          <VoucherAmount>decimal</VoucherAmount>
          <PaidAmount>decimal</PaidAmount>
          <ExpiryDate>dateTime</ExpiryDate>
          <VoucherRef>string</VoucherRef>
        </PaymentVoucherInfo>
        <PaymentAllocations>
          <PaymentAllocation>
            <AllocationDate>dateTime</AllocationDate>
            <Site xsi:nil="true" />
            <EmployeeID>long</EmployeeID>
            <AmountAllocatedFrom>decimal</AmountAllocatedFrom>
            <AmountAllocatedTo>decimal</AmountAllocatedTo>
            <InvoiceID>long</InvoiceID>
            <Customer xsi:nil="true" />
            <LedgerType xsi:nil="true" />
          </PaymentAllocation>
          <PaymentAllocation>
            <AllocationDate>dateTime</AllocationDate>
            <Site xsi:nil="true" />
            <EmployeeID>long</EmployeeID>
            <AmountAllocatedFrom>decimal</AmountAllocatedFrom>
            <AmountAllocatedTo>decimal</AmountAllocatedTo>
            <InvoiceID>long</InvoiceID>
            <Customer xsi:nil="true" />
            <LedgerType xsi:nil="true" />
          </PaymentAllocation>
        </PaymentAllocations>
        <Location>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Location>
        <Application>
          <ID>int</ID>
          <Name>string</Name>
          <DataType>int</DataType>
          <Length>int</Length>
          <IsMandatory>boolean</IsMandatory>
        </Application>
        <AuthCode>string</AuthCode>
        <AvailableToSpend>decimal</AvailableToSpend>
        <ExternalRef>string</ExternalRef>
        <LangCode>string</LangCode>
        <AccountBalance>decimal</AccountBalance>
        <CompanyName>string</CompanyName>
        <CompanyAddress>string</CompanyAddress>
        <SiteName>string</SiteName>
        <TotalAmountAllocated>decimal</TotalAmountAllocated>
      </pPayment>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </PaymentSave>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <PaymentSaveResponse xmlns="http://tempuri.org/">
      <PaymentSaveResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Payment>
            <PaymentDate>dateTime</PaymentDate>
            <PaymentMethod xsi:nil="true" />
            <Amount>decimal</Amount>
            <PaymentReference>string</PaymentReference>
            <Currency xsi:nil="true" />
            <ExchangeRate>decimal</ExchangeRate>
            <IsRefund>boolean</IsRefund>
            <ExternalReference>string</ExternalReference>
            <SaleOrderID>int</SaleOrderID>
            <Site xsi:nil="true" />
            <PaymentType xsi:nil="true" />
            <Comment>string</Comment>
            <PaymentLedgerType xsi:nil="true" />
            <IsDeposit>boolean</IsDeposit>
            <ShiftID>int</ShiftID>
            <WorkstationID>int</WorkstationID>
            <PaymentCardInfo xsi:nil="true" />
            <PaymentVoucherInfo xsi:nil="true" />
            <PaymentAllocations xsi:nil="true" />
            <Location xsi:nil="true" />
            <Application xsi:nil="true" />
            <AuthCode>string</AuthCode>
            <AvailableToSpend>decimal</AvailableToSpend>
            <ExternalRef>string</ExternalRef>
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <CompanyName>string</CompanyName>
            <CompanyAddress>string</CompanyAddress>
            <SiteName>string</SiteName>
            <TotalAmountAllocated>decimal</TotalAmountAllocated>
          </Payment>
          <Payment>
            <PaymentDate>dateTime</PaymentDate>
            <PaymentMethod xsi:nil="true" />
            <Amount>decimal</Amount>
            <PaymentReference>string</PaymentReference>
            <Currency xsi:nil="true" />
            <ExchangeRate>decimal</ExchangeRate>
            <IsRefund>boolean</IsRefund>
            <ExternalReference>string</ExternalReference>
            <SaleOrderID>int</SaleOrderID>
            <Site xsi:nil="true" />
            <PaymentType xsi:nil="true" />
            <Comment>string</Comment>
            <PaymentLedgerType xsi:nil="true" />
            <IsDeposit>boolean</IsDeposit>
            <ShiftID>int</ShiftID>
            <WorkstationID>int</WorkstationID>
            <PaymentCardInfo xsi:nil="true" />
            <PaymentVoucherInfo xsi:nil="true" />
            <PaymentAllocations xsi:nil="true" />
            <Location xsi:nil="true" />
            <Application xsi:nil="true" />
            <AuthCode>string</AuthCode>
            <AvailableToSpend>decimal</AvailableToSpend>
            <ExternalRef>string</ExternalRef>
            <LangCode>string</LangCode>
            <AccountBalance>decimal</AccountBalance>
            <CompanyName>string</CompanyName>
            <CompanyAddress>string</CompanyAddress>
            <SiteName>string</SiteName>
            <TotalAmountAllocated>decimal</TotalAmountAllocated>
          </Payment>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </PaymentSaveResult>
    </PaymentSaveResponse>
  </soap12:Body>
</soap12:Envelope>