ECRWebService Web Service

ECRWebService

Click here for a complete list of operations.

Web_VFI_TxnStatus

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 /ECRWebService.asmx HTTP/1.1
Host: staging-api.shory.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/Web_VFI_TxnStatus"

<?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>
    <Web_VFI_TxnStatus xmlns="http://tempuri.org/">
      <TerminalId>string</TerminalId>
      <ECRRcptNum>string</ECRRcptNum>
    </Web_VFI_TxnStatus>
  </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>
    <Web_VFI_TxnStatusResponse xmlns="http://tempuri.org/">
      <Web_VFI_TxnStatusResult>
        <VFI_ECRRcptNum>string</VFI_ECRRcptNum>
        <VFI_TransType>string</VFI_TransType>
        <VFI_Amount>string</VFI_Amount>
        <VFI_TIPAmount>string</VFI_TIPAmount>
        <VFI_PreauthComplAmount>string</VFI_PreauthComplAmount>
        <VFI_TID>string</VFI_TID>
        <VFI_MID>string</VFI_MID>
        <VFI_MessNum>string</VFI_MessNum>
        <VFI_Batch>string</VFI_Batch>
        <VFI_AuthMode>string</VFI_AuthMode>
        <VFI_TransSource>string</VFI_TransSource>
        <VFI_ApprovalCode>string</VFI_ApprovalCode>
        <VFI_VoidReceiptNum>string</VFI_VoidReceiptNum>
        <VFI_DateTime>string</VFI_DateTime>
        <VFI_RespCode>string</VFI_RespCode>
        <VFI_RespMess>string</VFI_RespMess>
        <VFI_RespType>string</VFI_RespType>
        <VFI_EMV_TSI>string</VFI_EMV_TSI>
        <VFI_EMV_AC>string</VFI_EMV_AC>
        <VFI_EMV_Label>string</VFI_EMV_Label>
        <VFI_EMV_AID>string</VFI_EMV_AID>
        <VFI_EMV_TVR>string</VFI_EMV_TVR>
        <VFI_DBCount>string</VFI_DBCount>
        <VFI_CRCount>string</VFI_CRCount>
        <VFI_DBAmount>string</VFI_DBAmount>
        <VFI_CRAmount>string</VFI_CRAmount>
        <VFI_ReportType>string</VFI_ReportType>
        <VFI_AdditionalInfo>string</VFI_AdditionalInfo>
        <VFI_RetRefNo>string</VFI_RetRefNo>
        <VFI_CompAmount>string</VFI_CompAmount>
        <VFI_CashAmount>string</VFI_CashAmount>
        <VFI_OrgionalRcptNum>string</VFI_OrgionalRcptNum>
        <VFI_Epp_Tenor>string</VFI_Epp_Tenor>
        <VFI_Epp_Invoice>string</VFI_Epp_Invoice>
        <VFI_Epp_Optin>string</VFI_Epp_Optin>
        <VFI_EMV_CID>string</VFI_EMV_CID>
        <VFI_ExchRate>string</VFI_ExchRate>
        <VFI_PYCAmount>string</VFI_PYCAmount>
        <VFI_MarkUp>string</VFI_MarkUp>
        <VFI_PYCCurr>string</VFI_PYCCurr>
        <VFI_PYCCurrName>string</VFI_PYCCurrName>
        <VFI_OptOut>string</VFI_OptOut>
        <VFI_QPSVeps>string</VFI_QPSVeps>
        <VFI_TxnDateTime>string</VFI_TxnDateTime>
        <VFI_PTID>string</VFI_PTID>
        <VFI_TslNo>string</VFI_TslNo>
        <Result>boolean</Result>
        <JsonResult>string</JsonResult>
        <VFI_RedeemedPoints>string</VFI_RedeemedPoints>
        <VFI_RedeemedAmount>string</VFI_RedeemedAmount>
        <VFI_VoucherNo>string</VFI_VoucherNo>
        <VFI_CouponMessage>string</VFI_CouponMessage>
        <VFI_Surcharge>string</VFI_Surcharge>
        <VFI_CardNum>string</VFI_CardNum>
        <VFI_Expiry>string</VFI_Expiry>
        <VFI_CHName>string</VFI_CHName>
        <VFI_CHVerification>string</VFI_CHVerification>
        <VFI_CardSchemeName>string</VFI_CardSchemeName>
        <VFI_AddInfo1>string</VFI_AddInfo1>
        <VFI_AddInfo2>string</VFI_AddInfo2>
        <VFI_AddInfo3>string</VFI_AddInfo3>
        <VFI_AddInfo4>string</VFI_AddInfo4>
        <VFI_AddInfo5>string</VFI_AddInfo5>
        <VFI_AddInfo6>string</VFI_AddInfo6>
        <VFI_AddInfo7>string</VFI_AddInfo7>
        <VFI_AddInfo8>string</VFI_AddInfo8>
        <VFI_AddInfo9>string</VFI_AddInfo9>
        <VFI_AddInfo10>string</VFI_AddInfo10>
        <VFI_AddInInfo1>string</VFI_AddInInfo1>
        <VFI_AddInInfo2>string</VFI_AddInInfo2>
        <VFI_AddInInfo3>string</VFI_AddInInfo3>
        <VFI_AddInInfo4>string</VFI_AddInInfo4>
        <VFI_AddInInfo5>string</VFI_AddInInfo5>
        <VFI_QRVoucherNo>string</VFI_QRVoucherNo>
        <VFI_VASRefId>string</VFI_VASRefId>
        <VFI_DCC_OptIn>string</VFI_DCC_OptIn>
        <VFI_EPP_TenorIndex>string</VFI_EPP_TenorIndex>
        <VFI_EPPMerchantInvoiceNo>string</VFI_EPPMerchantInvoiceNo>
        <VFI_XmlRespData>string</VFI_XmlRespData>
        <VFI_Loyalty>string</VFI_Loyalty>
        <VFI_VoidFlag>string</VFI_VoidFlag>
        <VFI_FailureCode>string</VFI_FailureCode>
        <VFI_FailureMessage>string</VFI_FailureMessage>
        <VFI_DomesticCurr>string</VFI_DomesticCurr>
        <VFI_MerchantName>string</VFI_MerchantName>
        <VFI_Address1>string</VFI_Address1>
        <VFI_Address2>string</VFI_Address2>
        <VFI_Address3>string</VFI_Address3>
        <VFI_POSApplicationVersion>string</VFI_POSApplicationVersion>
        <VFI_AddInfo11>string</VFI_AddInfo11>
        <VFI_AddInfo12>string</VFI_AddInfo12>
        <VFI_AddInfo13>string</VFI_AddInfo13>
        <VFI_AddInfo14>string</VFI_AddInfo14>
        <VFI_AddInfo15>string</VFI_AddInfo15>
        <VFI_AddInfo16>string</VFI_AddInfo16>
        <VFI_AddInfo17>string</VFI_AddInfo17>
        <VFI_AddInfo18>string</VFI_AddInfo18>
        <VFI_AddInfo19>string</VFI_AddInfo19>
        <VFI_AddInfo20>string</VFI_AddInfo20>
        <VFI_PaybyMerchantOrderNo>string</VFI_PaybyMerchantOrderNo>
        <VFI_PaybyOrderNo>string</VFI_PaybyOrderNo>
        <VFI_MerchantOrderNo>string</VFI_MerchantOrderNo>
        <VFI_AliPayOrderNo>string</VFI_AliPayOrderNo>
        <VFI_MerRefNo>string</VFI_MerRefNo>
        <VFI_ServiceId>string</VFI_ServiceId>
        <VFI_ServiceType>string</VFI_ServiceType>
        <VFI_ServiceCount>string</VFI_ServiceCount>
        <VFI_ServiceData>string</VFI_ServiceData>
        <VFI_ServiceAmount>string</VFI_ServiceAmount>
        <VFI_VatAmount>string</VFI_VatAmount>
        <VFI_ConfirmationCode>string</VFI_ConfirmationCode>
        <VFI_WalletType>string</VFI_WalletType>
        <VFI_MobileNumber>string</VFI_MobileNumber>
        <VFI_WalletOrderId>string</VFI_WalletOrderId>
        <VFI_CommunicationChannel>string</VFI_CommunicationChannel>
        <VFI_Epp_ProcPerc>string</VFI_Epp_ProcPerc>
        <VFI_Loyalty_Program_Name>string</VFI_Loyalty_Program_Name>
        <VFI_CardAmount>string</VFI_CardAmount>
        <VFI_QrSubTransType>string</VFI_QrSubTransType>
        <VFI_QrExtTransType>string</VFI_QrExtTransType>
      </Web_VFI_TxnStatusResult>
    </Web_VFI_TxnStatusResponse>
  </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 /ECRWebService.asmx HTTP/1.1
Host: staging-api.shory.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>
    <Web_VFI_TxnStatus xmlns="http://tempuri.org/">
      <TerminalId>string</TerminalId>
      <ECRRcptNum>string</ECRRcptNum>
    </Web_VFI_TxnStatus>
  </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>
    <Web_VFI_TxnStatusResponse xmlns="http://tempuri.org/">
      <Web_VFI_TxnStatusResult>
        <VFI_ECRRcptNum>string</VFI_ECRRcptNum>
        <VFI_TransType>string</VFI_TransType>
        <VFI_Amount>string</VFI_Amount>
        <VFI_TIPAmount>string</VFI_TIPAmount>
        <VFI_PreauthComplAmount>string</VFI_PreauthComplAmount>
        <VFI_TID>string</VFI_TID>
        <VFI_MID>string</VFI_MID>
        <VFI_MessNum>string</VFI_MessNum>
        <VFI_Batch>string</VFI_Batch>
        <VFI_AuthMode>string</VFI_AuthMode>
        <VFI_TransSource>string</VFI_TransSource>
        <VFI_ApprovalCode>string</VFI_ApprovalCode>
        <VFI_VoidReceiptNum>string</VFI_VoidReceiptNum>
        <VFI_DateTime>string</VFI_DateTime>
        <VFI_RespCode>string</VFI_RespCode>
        <VFI_RespMess>string</VFI_RespMess>
        <VFI_RespType>string</VFI_RespType>
        <VFI_EMV_TSI>string</VFI_EMV_TSI>
        <VFI_EMV_AC>string</VFI_EMV_AC>
        <VFI_EMV_Label>string</VFI_EMV_Label>
        <VFI_EMV_AID>string</VFI_EMV_AID>
        <VFI_EMV_TVR>string</VFI_EMV_TVR>
        <VFI_DBCount>string</VFI_DBCount>
        <VFI_CRCount>string</VFI_CRCount>
        <VFI_DBAmount>string</VFI_DBAmount>
        <VFI_CRAmount>string</VFI_CRAmount>
        <VFI_ReportType>string</VFI_ReportType>
        <VFI_AdditionalInfo>string</VFI_AdditionalInfo>
        <VFI_RetRefNo>string</VFI_RetRefNo>
        <VFI_CompAmount>string</VFI_CompAmount>
        <VFI_CashAmount>string</VFI_CashAmount>
        <VFI_OrgionalRcptNum>string</VFI_OrgionalRcptNum>
        <VFI_Epp_Tenor>string</VFI_Epp_Tenor>
        <VFI_Epp_Invoice>string</VFI_Epp_Invoice>
        <VFI_Epp_Optin>string</VFI_Epp_Optin>
        <VFI_EMV_CID>string</VFI_EMV_CID>
        <VFI_ExchRate>string</VFI_ExchRate>
        <VFI_PYCAmount>string</VFI_PYCAmount>
        <VFI_MarkUp>string</VFI_MarkUp>
        <VFI_PYCCurr>string</VFI_PYCCurr>
        <VFI_PYCCurrName>string</VFI_PYCCurrName>
        <VFI_OptOut>string</VFI_OptOut>
        <VFI_QPSVeps>string</VFI_QPSVeps>
        <VFI_TxnDateTime>string</VFI_TxnDateTime>
        <VFI_PTID>string</VFI_PTID>
        <VFI_TslNo>string</VFI_TslNo>
        <Result>boolean</Result>
        <JsonResult>string</JsonResult>
        <VFI_RedeemedPoints>string</VFI_RedeemedPoints>
        <VFI_RedeemedAmount>string</VFI_RedeemedAmount>
        <VFI_VoucherNo>string</VFI_VoucherNo>
        <VFI_CouponMessage>string</VFI_CouponMessage>
        <VFI_Surcharge>string</VFI_Surcharge>
        <VFI_CardNum>string</VFI_CardNum>
        <VFI_Expiry>string</VFI_Expiry>
        <VFI_CHName>string</VFI_CHName>
        <VFI_CHVerification>string</VFI_CHVerification>
        <VFI_CardSchemeName>string</VFI_CardSchemeName>
        <VFI_AddInfo1>string</VFI_AddInfo1>
        <VFI_AddInfo2>string</VFI_AddInfo2>
        <VFI_AddInfo3>string</VFI_AddInfo3>
        <VFI_AddInfo4>string</VFI_AddInfo4>
        <VFI_AddInfo5>string</VFI_AddInfo5>
        <VFI_AddInfo6>string</VFI_AddInfo6>
        <VFI_AddInfo7>string</VFI_AddInfo7>
        <VFI_AddInfo8>string</VFI_AddInfo8>
        <VFI_AddInfo9>string</VFI_AddInfo9>
        <VFI_AddInfo10>string</VFI_AddInfo10>
        <VFI_AddInInfo1>string</VFI_AddInInfo1>
        <VFI_AddInInfo2>string</VFI_AddInInfo2>
        <VFI_AddInInfo3>string</VFI_AddInInfo3>
        <VFI_AddInInfo4>string</VFI_AddInInfo4>
        <VFI_AddInInfo5>string</VFI_AddInInfo5>
        <VFI_QRVoucherNo>string</VFI_QRVoucherNo>
        <VFI_VASRefId>string</VFI_VASRefId>
        <VFI_DCC_OptIn>string</VFI_DCC_OptIn>
        <VFI_EPP_TenorIndex>string</VFI_EPP_TenorIndex>
        <VFI_EPPMerchantInvoiceNo>string</VFI_EPPMerchantInvoiceNo>
        <VFI_XmlRespData>string</VFI_XmlRespData>
        <VFI_Loyalty>string</VFI_Loyalty>
        <VFI_VoidFlag>string</VFI_VoidFlag>
        <VFI_FailureCode>string</VFI_FailureCode>
        <VFI_FailureMessage>string</VFI_FailureMessage>
        <VFI_DomesticCurr>string</VFI_DomesticCurr>
        <VFI_MerchantName>string</VFI_MerchantName>
        <VFI_Address1>string</VFI_Address1>
        <VFI_Address2>string</VFI_Address2>
        <VFI_Address3>string</VFI_Address3>
        <VFI_POSApplicationVersion>string</VFI_POSApplicationVersion>
        <VFI_AddInfo11>string</VFI_AddInfo11>
        <VFI_AddInfo12>string</VFI_AddInfo12>
        <VFI_AddInfo13>string</VFI_AddInfo13>
        <VFI_AddInfo14>string</VFI_AddInfo14>
        <VFI_AddInfo15>string</VFI_AddInfo15>
        <VFI_AddInfo16>string</VFI_AddInfo16>
        <VFI_AddInfo17>string</VFI_AddInfo17>
        <VFI_AddInfo18>string</VFI_AddInfo18>
        <VFI_AddInfo19>string</VFI_AddInfo19>
        <VFI_AddInfo20>string</VFI_AddInfo20>
        <VFI_PaybyMerchantOrderNo>string</VFI_PaybyMerchantOrderNo>
        <VFI_PaybyOrderNo>string</VFI_PaybyOrderNo>
        <VFI_MerchantOrderNo>string</VFI_MerchantOrderNo>
        <VFI_AliPayOrderNo>string</VFI_AliPayOrderNo>
        <VFI_MerRefNo>string</VFI_MerRefNo>
        <VFI_ServiceId>string</VFI_ServiceId>
        <VFI_ServiceType>string</VFI_ServiceType>
        <VFI_ServiceCount>string</VFI_ServiceCount>
        <VFI_ServiceData>string</VFI_ServiceData>
        <VFI_ServiceAmount>string</VFI_ServiceAmount>
        <VFI_VatAmount>string</VFI_VatAmount>
        <VFI_ConfirmationCode>string</VFI_ConfirmationCode>
        <VFI_WalletType>string</VFI_WalletType>
        <VFI_MobileNumber>string</VFI_MobileNumber>
        <VFI_WalletOrderId>string</VFI_WalletOrderId>
        <VFI_CommunicationChannel>string</VFI_CommunicationChannel>
        <VFI_Epp_ProcPerc>string</VFI_Epp_ProcPerc>
        <VFI_Loyalty_Program_Name>string</VFI_Loyalty_Program_Name>
        <VFI_CardAmount>string</VFI_CardAmount>
        <VFI_QrSubTransType>string</VFI_QrSubTransType>
        <VFI_QrExtTransType>string</VFI_QrExtTransType>
      </Web_VFI_TxnStatusResult>
    </Web_VFI_TxnStatusResponse>
  </soap12:Body>
</soap12:Envelope>