AIM Web Services

SubmitPOSTransactionRequest

In development, not yet for public use.

The following routes are available for this service:
POST	/api/SubmitPOSTransaction

**SubmitPOSTransactionRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Acct	body	int?	No
LocId	body	long?	No
TaxId	body	long?	No
Items	body	List<PosLineItem>	No
TenderType	query	string	No	Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER
OtherTenderCategory	query	string	No	Only applicable for Tender Type of OTHER. Send the Payment Category #
CardToken	body	string	No
CardExpiration	body	string	No
TokenPk	body	long?	No
SaveCard	body	bool	No
PONumber	body	string	No
TransactionMode	query	string	No	Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.
Deposit	query	decimal	No	Only valid for Approvals and Orders.
Notes	body	string	No
OnlineContractRef	query	string	No	Do Not Send This Parameter
ShipId	body	long?	No
CardTerminalId	body	string	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**PosLineItem** Parameters:
Name	Parameter	Data Type	Required
SkuPk	form	long?	No
SasPk	form	long?	No
Sku	form	string	No
Serial	form	string	No
Quantity	form	decimal	No
ExceptionInfo	form	ExceptionInfo	No
Discount	form	decimal?	No
NicsCat	form	int?	No
NicsSub	form	int?	No
PriceOverride	form	decimal?	No
AllowPriceOverrideToIgnoreMinPrice	form	bool	No
Notes	form	string	No

**ExceptionInfo** Parameters:
Name	Parameter	Data Type	Required
Barcode	form	string	No
Description	form	string	No
Base64Image	form	string	No
Category	form	int	No
SubCategory	form	int?	No

**SubmitPOSTransactionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
RefNumber	form	string	No
ErrorItems	form	List<PosResponseItem>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**PosResponseItem** Parameters:
Name	Parameter	Data Type	Required
PriceEach	form	decimal	No
Price	form	decimal	No
Discountable	form	bool	No
ErrorMessage	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/SubmitPOSTransaction HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubmitPOSTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <CardExpiration>String</CardExpiration>
  <CardTerminalId>String</CardTerminalId>
  <CardToken>String</CardToken>
  <Deposit>0</Deposit>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:PosLineItem>
      <d2p1:AllowPriceOverrideToIgnoreMinPrice>false</d2p1:AllowPriceOverrideToIgnoreMinPrice>
      <d2p1:Discount>0</d2p1:Discount>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:NicsCat>0</d2p1:NicsCat>
      <d2p1:NicsSub>0</d2p1:NicsSub>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:PriceOverride>0</d2p1:PriceOverride>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:PosLineItem>
  </Items>
  <LocId>0</LocId>
  <Notes>String</Notes>
  <OnlineContractRef>String</OnlineContractRef>
  <OtherTenderCategory>0</OtherTenderCategory>
  <PONumber>String</PONumber>
  <SaveCard>false</SaveCard>
  <ShipId>0</ShipId>
  <TaxId>0</TaxId>
  <TenderType>String</TenderType>
  <TokenPk>0</TokenPk>
  <TransactionMode>String</TransactionMode>
</SubmitPOSTransactionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SubmitPOSTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <ErrorItems>
    <PosResponseItem>
      <AllowPriceOverrideToIgnoreMinPrice xmlns="http://schemas.datacontract.org/2004/07/AIM">false</AllowPriceOverrideToIgnoreMinPrice>
      <Discount xmlns="http://schemas.datacontract.org/2004/07/AIM">0</Discount>
      <ExceptionInfo xmlns="http://schemas.datacontract.org/2004/07/AIM">
        <Barcode>String</Barcode>
        <Base64Image>String</Base64Image>
        <Category>0</Category>
        <Description>String</Description>
        <SubCategory>0</SubCategory>
      </ExceptionInfo>
      <NicsCat xmlns="http://schemas.datacontract.org/2004/07/AIM">0</NicsCat>
      <NicsSub xmlns="http://schemas.datacontract.org/2004/07/AIM">0</NicsSub>
      <Notes xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Notes>
      <PriceOverride xmlns="http://schemas.datacontract.org/2004/07/AIM">0</PriceOverride>
      <Quantity xmlns="http://schemas.datacontract.org/2004/07/AIM">0</Quantity>
      <SasPk xmlns="http://schemas.datacontract.org/2004/07/AIM">0</SasPk>
      <Serial xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Serial>
      <Sku xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Sku>
      <SkuPk xmlns="http://schemas.datacontract.org/2004/07/AIM">0</SkuPk>
      <Discountable>false</Discountable>
      <ErrorMessage>String</ErrorMessage>
      <Price>0</Price>
      <PriceEach>0</PriceEach>
    </PosResponseItem>
  </ErrorItems>
  <RefNumber>String</RefNumber>
</SubmitPOSTransactionResponse>