ApexERPHost

<back to all web services

WsRegisterTransaction

Requires Authentication
The following routes are available for this service:
POST/POS/WissolCards/RegisterTransaction
WsRegisterTransaction Parameters:
NameParameterData TypeRequiredDescription
DatabodyWsRegisterTransactionReqNo
WsRegisterTransactionReq Parameters:
NameParameterData TypeRequiredDescription
agentTransactionIdformstringNo
sessionIdformlongNo
customerCardNumberformstringNo
callerformWsCallerNo
paymentformList<WsPayment>No
receiptformWsReceiptNo
agentTransactionDateTimeformstringNo
languageCodeformstringNo
businessDayformintNo
businessDayDateformstringNo
additionalDataformstringNo
WsCaller Parameters:
NameParameterData TypeRequiredDescription
branchformintNo
companyCodeformstringNo
companyTokenformstringNo
posCodeformstringNo
posDeviceCodeformstringNo
operatorIdformstringNo
WsPayment Parameters:
NameParameterData TypeRequiredDescription
acquirerIdformlongNo
approvalCodeformlongNo
amountformfloatNo
paymentTypeformWsPayTypeNo
timeStampformstringNo
cardCircuitformstringNo
cardPanformstringNo
expiryDateformstringNo
WsReceipt Parameters:
NameParameterData TypeRequiredDescription
productsformList<WsProduct>No
totalAmountformfloatNo
productDiscountAmountformfloatNo
basketDiscountAmountformfloatNo
giftDiscountAmountformfloatNo
WsProduct Parameters:
NameParameterData TypeRequiredDescription
productCodeformstringNo
productStatusformstringNo
quantityformfloatNo
priceformfloatNo
giftDiscountformfloatNo
discountformfloatNo
discountedPriceformfloatNo
WsRegisterTransactionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformWsRegisterTransactionRespNo
ErrorInfoformList<WsErrorInfo>No
WsRegisterTransactionResp Parameters:
NameParameterData TypeRequiredDescription
transactionIdformlongNo
sessionIdformlongNo
customerformWsCustomerNo
earnedPointsformfloatNo
earnedGiftsformstringNo
statusformstringNo
transactionErrorCauseListformList<string>No
requestformWsRegisterTransactionReqNo
WsCustomer Parameters:
NameParameterData TypeRequiredDescription
cardNumberformstringNo
nameformstringNo
clientStatusformstringNo
clientPhoneformstringNo
clientEMailformstringNo
cardStatusformstringNo
cardCategoryformstringNo
cardNameformstringNo
loyaltyPointsformfloatNo
loyaltyPointsAmountformfloatNo
activationDateformDateTime?No
expirationDateformDateTime?No
isSelectedformboolNo
WsErrorInfo Parameters:
NameParameterData TypeRequiredDescription
errorformstringNo
messageformstringNo
translatedMessageformstringNo
fieldformstringNo
otpKeyformstringNo

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 /POS/WissolCards/RegisterTransaction HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WsRegisterTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.POS">
  <Data>
    <agentTransactionId>String</agentTransactionId>
    <sessionId>0</sessionId>
    <customerCardNumber>String</customerCardNumber>
    <caller>
      <branch>0</branch>
      <companyCode>String</companyCode>
      <companyToken>String</companyToken>
      <posCode>String</posCode>
      <posDeviceCode>String</posDeviceCode>
      <operatorId>String</operatorId>
    </caller>
    <payment>
      <WsPayment>
        <acquirerId>0</acquirerId>
        <approvalCode>0</approvalCode>
        <amount>0</amount>
        <paymentType>CASH</paymentType>
        <timeStamp>String</timeStamp>
        <cardCircuit>String</cardCircuit>
        <cardPan>String</cardPan>
        <expiryDate>String</expiryDate>
      </WsPayment>
    </payment>
    <receipt>
      <products>
        <WsProduct>
          <productCode>String</productCode>
          <productStatus>String</productStatus>
          <quantity>0</quantity>
          <price>0</price>
          <giftDiscount>0</giftDiscount>
          <discount>0</discount>
          <discountedPrice>0</discountedPrice>
        </WsProduct>
      </products>
      <totalAmount>0</totalAmount>
      <productDiscountAmount>0</productDiscountAmount>
      <basketDiscountAmount>0</basketDiscountAmount>
      <giftDiscountAmount>0</giftDiscountAmount>
    </receipt>
    <agentTransactionDateTime>String</agentTransactionDateTime>
    <languageCode>String</languageCode>
    <businessDay>0</businessDay>
    <businessDayDate>String</businessDayDate>
    <additionalData>String</additionalData>
  </Data>
</WsRegisterTransaction>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WsRegisterTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.POS">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <transactionId>0</transactionId>
    <sessionId>0</sessionId>
    <customer>
      <cardNumber>String</cardNumber>
      <name>String</name>
      <clientStatus>String</clientStatus>
      <clientPhone>String</clientPhone>
      <clientEMail>String</clientEMail>
      <cardStatus>String</cardStatus>
      <cardCategory>String</cardCategory>
      <cardName>String</cardName>
      <loyaltyPoints>0</loyaltyPoints>
      <loyaltyPointsAmount>0</loyaltyPointsAmount>
      <activationDate>0001-01-01T00:00:00</activationDate>
      <expirationDate>0001-01-01T00:00:00</expirationDate>
      <isSelected>false</isSelected>
    </customer>
    <earnedPoints>0</earnedPoints>
    <earnedGifts>String</earnedGifts>
    <status>String</status>
    <transactionErrorCauseList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </transactionErrorCauseList>
    <request>
      <agentTransactionId>String</agentTransactionId>
      <sessionId>0</sessionId>
      <customerCardNumber>String</customerCardNumber>
      <caller>
        <branch>0</branch>
        <companyCode>String</companyCode>
        <companyToken>String</companyToken>
        <posCode>String</posCode>
        <posDeviceCode>String</posDeviceCode>
        <operatorId>String</operatorId>
      </caller>
      <payment>
        <WsPayment>
          <acquirerId>0</acquirerId>
          <approvalCode>0</approvalCode>
          <amount>0</amount>
          <paymentType>CASH</paymentType>
          <timeStamp>String</timeStamp>
          <cardCircuit>String</cardCircuit>
          <cardPan>String</cardPan>
          <expiryDate>String</expiryDate>
        </WsPayment>
      </payment>
      <receipt>
        <products>
          <WsProduct>
            <productCode>String</productCode>
            <productStatus>String</productStatus>
            <quantity>0</quantity>
            <price>0</price>
            <giftDiscount>0</giftDiscount>
            <discount>0</discount>
            <discountedPrice>0</discountedPrice>
          </WsProduct>
        </products>
        <totalAmount>0</totalAmount>
        <productDiscountAmount>0</productDiscountAmount>
        <basketDiscountAmount>0</basketDiscountAmount>
        <giftDiscountAmount>0</giftDiscountAmount>
      </receipt>
      <agentTransactionDateTime>String</agentTransactionDateTime>
      <languageCode>String</languageCode>
      <businessDay>0</businessDay>
      <businessDayDate>String</businessDayDate>
      <additionalData>String</additionalData>
    </request>
  </Result>
  <ErrorInfo>
    <WsErrorInfo>
      <error>String</error>
      <message>String</message>
      <translatedMessage>String</translatedMessage>
      <field>String</field>
      <otpKey>String</otpKey>
    </WsErrorInfo>
  </ErrorInfo>
</WsRegisterTransactionResponse>