iSAMS Orders API


Click here for a complete list of operations.

AddTransaction

Adds a payment transaction to an order.

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 /global/api/Orders.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/orders/AddTransaction"

<?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>
    <AddTransaction xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <orderID>int</orderID>
      <transaction>
        <ID xmlns="http://www.estaronline.com/api">int</ID>
        <TransactionType xmlns="http://www.estaronline.com/api">None or CreditCard or Voucher or Account or Cheque or CashSale or BarterCard or External or ExternalPayPal or PayPalSaleRefund or PayPal or EFTPOS or InternetBanking or NoCharge or DirectCredit or ExternalPOS or Phone or PaymentOnPickUp or GiftCard or ZipMoney or OpenPay or AfterPay or eShopWorld or Laybuy or Oxipay or PaymentExpress or ApplePay or Alipay or OnlineEftpos or ServerInitiatedTransaction or Klarna or GemInterestFree or LatitudeInterestFree or Braintree or ApplePayDirect or QantasPoints or ManagedPayments</TransactionType>
        <TransactionAmount xmlns="http://www.estaronline.com/api">decimal</TransactionAmount>
        <TransactionDate xmlns="http://www.estaronline.com/api">dateTime</TransactionDate>
        <TransactionStatus xmlns="http://www.estaronline.com/api">int</TransactionStatus>
        <CardNumber xmlns="http://www.estaronline.com/api">string</CardNumber>
        <CardExpiryMonth xmlns="http://www.estaronline.com/api">string</CardExpiryMonth>
        <CardExpiryYear xmlns="http://www.estaronline.com/api">string</CardExpiryYear>
        <CardType xmlns="http://www.estaronline.com/api">string</CardType>
        <CardName xmlns="http://www.estaronline.com/api">string</CardName>
        <VoucherID xmlns="http://www.estaronline.com/api">string</VoucherID>
        <GiftCardNumber xmlns="http://www.estaronline.com/api">string</GiftCardNumber>
        <AccountID xmlns="http://www.estaronline.com/api">string</AccountID>
      </transaction>
    </AddTransaction>
  </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>
    <AddTransactionResponse xmlns="http://www.estaronline.com/api/orders">
      <AddTransactionResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </AddTransactionResult>
    </AddTransactionResponse>
  </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 /global/api/Orders.asmx HTTP/1.1
Host: demo.viare.io
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>
    <AddTransaction xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <orderID>int</orderID>
      <transaction>
        <ID xmlns="http://www.estaronline.com/api">int</ID>
        <TransactionType xmlns="http://www.estaronline.com/api">None or CreditCard or Voucher or Account or Cheque or CashSale or BarterCard or External or ExternalPayPal or PayPalSaleRefund or PayPal or EFTPOS or InternetBanking or NoCharge or DirectCredit or ExternalPOS or Phone or PaymentOnPickUp or GiftCard or ZipMoney or OpenPay or AfterPay or eShopWorld or Laybuy or Oxipay or PaymentExpress or ApplePay or Alipay or OnlineEftpos or ServerInitiatedTransaction or Klarna or GemInterestFree or LatitudeInterestFree or Braintree or ApplePayDirect or QantasPoints or ManagedPayments</TransactionType>
        <TransactionAmount xmlns="http://www.estaronline.com/api">decimal</TransactionAmount>
        <TransactionDate xmlns="http://www.estaronline.com/api">dateTime</TransactionDate>
        <TransactionStatus xmlns="http://www.estaronline.com/api">int</TransactionStatus>
        <CardNumber xmlns="http://www.estaronline.com/api">string</CardNumber>
        <CardExpiryMonth xmlns="http://www.estaronline.com/api">string</CardExpiryMonth>
        <CardExpiryYear xmlns="http://www.estaronline.com/api">string</CardExpiryYear>
        <CardType xmlns="http://www.estaronline.com/api">string</CardType>
        <CardName xmlns="http://www.estaronline.com/api">string</CardName>
        <VoucherID xmlns="http://www.estaronline.com/api">string</VoucherID>
        <GiftCardNumber xmlns="http://www.estaronline.com/api">string</GiftCardNumber>
        <AccountID xmlns="http://www.estaronline.com/api">string</AccountID>
      </transaction>
    </AddTransaction>
  </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>
    <AddTransactionResponse xmlns="http://www.estaronline.com/api/orders">
      <AddTransactionResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </AddTransactionResult>
    </AddTransactionResponse>
  </soap12:Body>
</soap12:Envelope>