Service Web Service

Service

Click here for a complete list of operations.

BlockVIP

این سرویس برای مسدود کردن مبلغ مشخصی از حساب به صورت VIP مورد استفاده قرار می گیرد

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 /Service.asmx HTTP/1.1
Host: api-uat.bki.ir
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/BlockVIP"

<?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>
    <BlockVIP xmlns="http://tempuri.org/">
      <sessionUniqueId>string</sessionUniqueId>
      <requestNumber>int</requestNumber>
      <accountNumber>string</accountNumber>
      <holdValue>decimal</holdValue>
      <holdReason>string</holdReason>
      <memo1>string</memo1>
      <memo2>string</memo2>
      <code1>string</code1>
      <code2>string</code2>
      <code3>string</code3>
      <receiptNo>string</receiptNo>
      <customerType>string</customerType>
      <MAC>base64Binary</MAC>
      <code1IsUnique>boolean</code1IsUnique>
    </BlockVIP>
  </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>
    <BlockVIPResponse xmlns="http://tempuri.org/">
      <BlockVIPResult>int</BlockVIPResult>
      <response>
        <GeneratedCode1>string</GeneratedCode1>
        <JournalNumber>string</JournalNumber>
        <resData>
          <string>string</string>
          <string>string</string>
        </resData>
        <StatusCode>int</StatusCode>
        <TransactionDateTime>string</TransactionDateTime>
      </response>
      <HostDate>string</HostDate>
      <HostTime>string</HostTime>
    </BlockVIPResponse>
  </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 /Service.asmx HTTP/1.1
Host: api-uat.bki.ir
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>
    <BlockVIP xmlns="http://tempuri.org/">
      <sessionUniqueId>string</sessionUniqueId>
      <requestNumber>int</requestNumber>
      <accountNumber>string</accountNumber>
      <holdValue>decimal</holdValue>
      <holdReason>string</holdReason>
      <memo1>string</memo1>
      <memo2>string</memo2>
      <code1>string</code1>
      <code2>string</code2>
      <code3>string</code3>
      <receiptNo>string</receiptNo>
      <customerType>string</customerType>
      <MAC>base64Binary</MAC>
      <code1IsUnique>boolean</code1IsUnique>
    </BlockVIP>
  </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>
    <BlockVIPResponse xmlns="http://tempuri.org/">
      <BlockVIPResult>int</BlockVIPResult>
      <response>
        <GeneratedCode1>string</GeneratedCode1>
        <JournalNumber>string</JournalNumber>
        <resData>
          <string>string</string>
          <string>string</string>
        </resData>
        <StatusCode>int</StatusCode>
        <TransactionDateTime>string</TransactionDateTime>
      </response>
      <HostDate>string</HostDate>
      <HostTime>string</HostTime>
    </BlockVIPResponse>
  </soap12:Body>
</soap12:Envelope>