TransactionWebServices

Click here for a complete list of operations.

ExecuteVposRequest

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 /v4/TransactionServices.asmx HTTP/1.1
Host: sanalpos.ziraatbank.com.tr
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "PayFlexVPosWebService/ExecuteVposRequest"

<?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>
    <ExecuteVposRequest xmlns="PayFlexVPosWebService">
      <vposRequest>
        <MerchantId>string</MerchantId>
        <Identity>string</Identity>
        <Password>string</Password>
        <TerminalNo>string</TerminalNo>
        <TransactionType>string</TransactionType>
        <ApiTransactionType>string</ApiTransactionType>
        <TransactionId>string</TransactionId>
        <ReferenceTransactionId>string</ReferenceTransactionId>
        <NumberOfInstallments>int</NumberOfInstallments>
        <CurrencyAmount>decimal</CurrencyAmount>
        <AmountShare>decimal</AmountShare>
        <SurchargeAmount>decimal</SurchargeAmount>
        <CurrencyCode>int</CurrencyCode>
        <PointAmount>decimal</PointAmount>
        <TotalPointAmount>decimal</TotalPointAmount>
        <PointCode>int</PointCode>
        <Pan>string</Pan>
        <CardNoFirst>string</CardNoFirst>
        <CardNoLast>string</CardNoLast>
        <InstallmentCount>string</InstallmentCount>
        <InquiryValue>string</InquiryValue>
        <Cvv>string</Cvv>
        <SecurityCode>string</SecurityCode>
        <Expiry>string</Expiry>
        <Location>int</Location>
        <Extract>string</Extract>
        <DeviceType>int</DeviceType>
        <TAVV>string</TAVV>
        <CardHoldersName>string</CardHoldersName>
        <ClientIp>string</ClientIp>
        <MerchantIp>string</MerchantIp>
        <CardHoldersEmail>string</CardHoldersEmail>
        <OrderId>string</OrderId>
        <OrderDescription>string</OrderDescription>
        <TriggerDate>string</TriggerDate>
        <IsRecurring>boolean</IsRecurring>
        <IsInvoice>boolean</IsInvoice>
        <RecurringFrequencyType>string</RecurringFrequencyType>
        <RecurringFrequency>int</RecurringFrequency>
        <RecurringInstallmentCount>int</RecurringInstallmentCount>
        <MpiTransactionId>string</MpiTransactionId>
        <ExpSign>string</ExpSign>
        <CAVV>string</CAVV>
        <ECI>string</ECI>
        <CustomItems>
          <Item name="string" value="string" customType="string" />
          <Item name="string" value="string" customType="string" />
        </CustomItems>
        <CustomInstallments>
          <CustomInstallment date="string" amount="decimal" />
          <CustomInstallment date="string" amount="decimal" />
          <MaturityPeriod>int</MaturityPeriod>
          <Frequency>int</Frequency>
        </CustomInstallments>
        <BrandName>string</BrandName>
        <PanMasked>string</PanMasked>
        <CvvMasked>string</CvvMasked>
        <TransactionDeviceSource>int</TransactionDeviceSource>
        <SecurityCodeMasked>string</SecurityCodeMasked>
        <CustomerNumber>string</CustomerNumber>
        <CustomerName>string</CustomerName>
        <PanCode>string</PanCode>
        <HostSubMerchantId>string</HostSubMerchantId>
        <MerchantType>int</MerchantType>
        <TransactionSource>int</TransactionSource>
        <IncludeHostResultCode>boolean</IncludeHostResultCode>
        <CampaignResult>
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
        </CampaignResult>
        <StoreNo>string</StoreNo>
        <TransactionChannel>int</TransactionChannel>
        <IsTriggeredByBatchCloseFlow>boolean</IsTriggeredByBatchCloseFlow>
        <BKHesapNo>string</BKHesapNo>
        <BKUrunKodu>string</BKUrunKodu>
        <HKUrunKodu>string</HKUrunKodu>
        <HKPlasiyerNo>string</HKPlasiyerNo>
        <HKFaturaNo>string</HKFaturaNo>
        <HKVadeKodu>string</HKVadeKodu>
        <HKVadeAdedi>int</HKVadeAdedi>
        <HKVadeBilgi>string</HKVadeBilgi>
      </vposRequest>
    </ExecuteVposRequest>
  </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>
    <ExecuteVposRequestResponse xmlns="PayFlexVPosWebService">
      <ExecuteVposRequestResult>
        <MerchantId>string</MerchantId>
        <TransactionType>string</TransactionType>
        <TransactionId>string</TransactionId>
        <ReferenceTransactionId>string</ReferenceTransactionId>
        <ResultCode>string</ResultCode>
        <ResultDetail>string</ResultDetail>
        <CustomItems>
          <Item name="string" value="string" customType="string" />
          <Item name="string" value="string" customType="string" />
        </CustomItems>
        <InstallmentTable>
          <InstallmentItem date="string" amount="decimal" />
          <InstallmentItem date="string" amount="decimal" />
        </InstallmentTable>
        <CampaignResult>
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
        </CampaignResult>
        <MerchantCampaignResult>
          <HostResponseCode>string</HostResponseCode>
          <HostResponseMessage>string</HostResponseMessage>
          <CampaignInfos>
            <CampaignInfo xsi:nil="true" />
            <CampaignInfo xsi:nil="true" />
          </CampaignInfos>
        </MerchantCampaignResult>
        <AuthCode>string</AuthCode>
        <HostDate>string</HostDate>
        <Rrn>string</Rrn>
        <PointLosts>decimal</PointLosts>
        <TerminalNo>string</TerminalNo>
        <PointAmount>decimal</PointAmount>
        <PointCode>int</PointCode>
        <GainedPoint>decimal</GainedPoint>
        <TotalPoint>decimal</TotalPoint>
        <CurrencyAmount>decimal</CurrencyAmount>
        <CurrencyCode>int</CurrencyCode>
        <VftAmount>decimal</VftAmount>
        <SurchargeAmount>decimal</SurchargeAmount>
        <NumberOfInstallments>int</NumberOfInstallments>
        <InstallmentCount>int</InstallmentCount>
        <RecurringInstallmentCount>int</RecurringInstallmentCount>
        <OrderId>string</OrderId>
        <ECI>string</ECI>
        <ThreeDSecureType>int</ThreeDSecureType>
        <TransactionDeviceSource>int</TransactionDeviceSource>
        <Location>int</Location>
        <DeviceType>int</DeviceType>
        <Tavv>string</Tavv>
        <BatchNo>int</BatchNo>
        <PanCode>string</PanCode>
        <TLAmount>decimal</TLAmount>
        <LimitSearchResults>
          <LimitSearchResult type="string" limit="decimal" />
          <LimitSearchResult type="string" limit="decimal" />
        </LimitSearchResults>
        <PlanSearchResults>
          <PlanSearchResult maturityPeriod="int" frequency="int" />
          <PlanSearchResult maturityPeriod="int" frequency="int" />
        </PlanSearchResults>
        <HostSubMerchantId>string</HostSubMerchantId>
        <Identity>string</Identity>
        <MerchantType>int</MerchantType>
        <HostResultCode>string</HostResultCode>
        <BKAccounts>
          <BKAccount HesapNo="string" HesapAdi="string">
            <BKKonuLimits xsi:nil="true" />
          </BKAccount>
          <BKAccount HesapNo="string" HesapAdi="string">
            <BKKonuLimits xsi:nil="true" />
          </BKAccount>
        </BKAccounts>
        <BKSaleInfo expiryDate="string" productDesc="string" numberOfDays="string" />
        <BatchShouldClose>boolean</BatchShouldClose>
      </ExecuteVposRequestResult>
    </ExecuteVposRequestResponse>
  </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 /v4/TransactionServices.asmx HTTP/1.1
Host: sanalpos.ziraatbank.com.tr
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>
    <ExecuteVposRequest xmlns="PayFlexVPosWebService">
      <vposRequest>
        <MerchantId>string</MerchantId>
        <Identity>string</Identity>
        <Password>string</Password>
        <TerminalNo>string</TerminalNo>
        <TransactionType>string</TransactionType>
        <ApiTransactionType>string</ApiTransactionType>
        <TransactionId>string</TransactionId>
        <ReferenceTransactionId>string</ReferenceTransactionId>
        <NumberOfInstallments>int</NumberOfInstallments>
        <CurrencyAmount>decimal</CurrencyAmount>
        <AmountShare>decimal</AmountShare>
        <SurchargeAmount>decimal</SurchargeAmount>
        <CurrencyCode>int</CurrencyCode>
        <PointAmount>decimal</PointAmount>
        <TotalPointAmount>decimal</TotalPointAmount>
        <PointCode>int</PointCode>
        <Pan>string</Pan>
        <CardNoFirst>string</CardNoFirst>
        <CardNoLast>string</CardNoLast>
        <InstallmentCount>string</InstallmentCount>
        <InquiryValue>string</InquiryValue>
        <Cvv>string</Cvv>
        <SecurityCode>string</SecurityCode>
        <Expiry>string</Expiry>
        <Location>int</Location>
        <Extract>string</Extract>
        <DeviceType>int</DeviceType>
        <TAVV>string</TAVV>
        <CardHoldersName>string</CardHoldersName>
        <ClientIp>string</ClientIp>
        <MerchantIp>string</MerchantIp>
        <CardHoldersEmail>string</CardHoldersEmail>
        <OrderId>string</OrderId>
        <OrderDescription>string</OrderDescription>
        <TriggerDate>string</TriggerDate>
        <IsRecurring>boolean</IsRecurring>
        <IsInvoice>boolean</IsInvoice>
        <RecurringFrequencyType>string</RecurringFrequencyType>
        <RecurringFrequency>int</RecurringFrequency>
        <RecurringInstallmentCount>int</RecurringInstallmentCount>
        <MpiTransactionId>string</MpiTransactionId>
        <ExpSign>string</ExpSign>
        <CAVV>string</CAVV>
        <ECI>string</ECI>
        <CustomItems>
          <Item name="string" value="string" customType="string" />
          <Item name="string" value="string" customType="string" />
        </CustomItems>
        <CustomInstallments>
          <CustomInstallment date="string" amount="decimal" />
          <CustomInstallment date="string" amount="decimal" />
          <MaturityPeriod>int</MaturityPeriod>
          <Frequency>int</Frequency>
        </CustomInstallments>
        <BrandName>string</BrandName>
        <PanMasked>string</PanMasked>
        <CvvMasked>string</CvvMasked>
        <TransactionDeviceSource>int</TransactionDeviceSource>
        <SecurityCodeMasked>string</SecurityCodeMasked>
        <CustomerNumber>string</CustomerNumber>
        <CustomerName>string</CustomerName>
        <PanCode>string</PanCode>
        <HostSubMerchantId>string</HostSubMerchantId>
        <MerchantType>int</MerchantType>
        <TransactionSource>int</TransactionSource>
        <IncludeHostResultCode>boolean</IncludeHostResultCode>
        <CampaignResult>
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
        </CampaignResult>
        <StoreNo>string</StoreNo>
        <TransactionChannel>int</TransactionChannel>
        <IsTriggeredByBatchCloseFlow>boolean</IsTriggeredByBatchCloseFlow>
        <BKHesapNo>string</BKHesapNo>
        <BKUrunKodu>string</BKUrunKodu>
        <HKUrunKodu>string</HKUrunKodu>
        <HKPlasiyerNo>string</HKPlasiyerNo>
        <HKFaturaNo>string</HKFaturaNo>
        <HKVadeKodu>string</HKVadeKodu>
        <HKVadeAdedi>int</HKVadeAdedi>
        <HKVadeBilgi>string</HKVadeBilgi>
      </vposRequest>
    </ExecuteVposRequest>
  </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>
    <ExecuteVposRequestResponse xmlns="PayFlexVPosWebService">
      <ExecuteVposRequestResult>
        <MerchantId>string</MerchantId>
        <TransactionType>string</TransactionType>
        <TransactionId>string</TransactionId>
        <ReferenceTransactionId>string</ReferenceTransactionId>
        <ResultCode>string</ResultCode>
        <ResultDetail>string</ResultDetail>
        <CustomItems>
          <Item name="string" value="string" customType="string" />
          <Item name="string" value="string" customType="string" />
        </CustomItems>
        <InstallmentTable>
          <InstallmentItem date="string" amount="decimal" />
          <InstallmentItem date="string" amount="decimal" />
        </InstallmentTable>
        <CampaignResult>
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
          <CampaignItem action="string" code="string" description="string" extradescription="string" />
        </CampaignResult>
        <MerchantCampaignResult>
          <HostResponseCode>string</HostResponseCode>
          <HostResponseMessage>string</HostResponseMessage>
          <CampaignInfos>
            <CampaignInfo xsi:nil="true" />
            <CampaignInfo xsi:nil="true" />
          </CampaignInfos>
        </MerchantCampaignResult>
        <AuthCode>string</AuthCode>
        <HostDate>string</HostDate>
        <Rrn>string</Rrn>
        <PointLosts>decimal</PointLosts>
        <TerminalNo>string</TerminalNo>
        <PointAmount>decimal</PointAmount>
        <PointCode>int</PointCode>
        <GainedPoint>decimal</GainedPoint>
        <TotalPoint>decimal</TotalPoint>
        <CurrencyAmount>decimal</CurrencyAmount>
        <CurrencyCode>int</CurrencyCode>
        <VftAmount>decimal</VftAmount>
        <SurchargeAmount>decimal</SurchargeAmount>
        <NumberOfInstallments>int</NumberOfInstallments>
        <InstallmentCount>int</InstallmentCount>
        <RecurringInstallmentCount>int</RecurringInstallmentCount>
        <OrderId>string</OrderId>
        <ECI>string</ECI>
        <ThreeDSecureType>int</ThreeDSecureType>
        <TransactionDeviceSource>int</TransactionDeviceSource>
        <Location>int</Location>
        <DeviceType>int</DeviceType>
        <Tavv>string</Tavv>
        <BatchNo>int</BatchNo>
        <PanCode>string</PanCode>
        <TLAmount>decimal</TLAmount>
        <LimitSearchResults>
          <LimitSearchResult type="string" limit="decimal" />
          <LimitSearchResult type="string" limit="decimal" />
        </LimitSearchResults>
        <PlanSearchResults>
          <PlanSearchResult maturityPeriod="int" frequency="int" />
          <PlanSearchResult maturityPeriod="int" frequency="int" />
        </PlanSearchResults>
        <HostSubMerchantId>string</HostSubMerchantId>
        <Identity>string</Identity>
        <MerchantType>int</MerchantType>
        <HostResultCode>string</HostResultCode>
        <BKAccounts>
          <BKAccount HesapNo="string" HesapAdi="string">
            <BKKonuLimits xsi:nil="true" />
          </BKAccount>
          <BKAccount HesapNo="string" HesapAdi="string">
            <BKKonuLimits xsi:nil="true" />
          </BKAccount>
        </BKAccounts>
        <BKSaleInfo expiryDate="string" productDesc="string" numberOfDays="string" />
        <BatchShouldClose>boolean</BatchShouldClose>
      </ExecuteVposRequestResult>
    </ExecuteVposRequestResponse>
  </soap12:Body>
</soap12:Envelope>