Service Web Service

Service

Click here for a complete list of operations.

PayaTransaction

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/PayaTransaction"

<?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>
    <PayaTransaction xmlns="http://tempuri.org/">
      <sessionUniqueId>string</sessionUniqueId>
      <ip>string</ip>
      <requestNumber>int</requestNumber>
      <CostumerCode>string</CostumerCode>
      <amount>decimal</amount>
      <receiverFirstName>string</receiverFirstName>
      <receiverLastName>string</receiverLastName>
      <receiverIBAN>string</receiverIBAN>
      <receiverNID>string</receiverNID>
      <receiverPhone>string</receiverPhone>
      <senderIBAN>string</senderIBAN>
      <comment>string</comment>
      <paymentIdentifier>string</paymentIdentifier>
      <userCode>string</userCode>
      <referenceCode>string</referenceCode>
      <MAC>base64Binary</MAC>
    </PayaTransaction>
  </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>
    <PayaTransactionResponse xmlns="http://tempuri.org/">
      <PayaTransactionResult>
        <response>
          <string>string</string>
          <string>string</string>
        </response>
        <Status>string</Status>
        <TrakingCode>string</TrakingCode>
        <ErrorCode>string</ErrorCode>
        <JurnalNumber>string</JurnalNumber>
        <TrransactionDate>string</TrransactionDate>
        <Extera>string</Extera>
        <Description>string</Description>
      </PayaTransactionResult>
      <response>
        <string>string</string>
        <string>string</string>
      </response>
    </PayaTransactionResponse>
  </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>
    <PayaTransaction xmlns="http://tempuri.org/">
      <sessionUniqueId>string</sessionUniqueId>
      <ip>string</ip>
      <requestNumber>int</requestNumber>
      <CostumerCode>string</CostumerCode>
      <amount>decimal</amount>
      <receiverFirstName>string</receiverFirstName>
      <receiverLastName>string</receiverLastName>
      <receiverIBAN>string</receiverIBAN>
      <receiverNID>string</receiverNID>
      <receiverPhone>string</receiverPhone>
      <senderIBAN>string</senderIBAN>
      <comment>string</comment>
      <paymentIdentifier>string</paymentIdentifier>
      <userCode>string</userCode>
      <referenceCode>string</referenceCode>
      <MAC>base64Binary</MAC>
    </PayaTransaction>
  </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>
    <PayaTransactionResponse xmlns="http://tempuri.org/">
      <PayaTransactionResult>
        <response>
          <string>string</string>
          <string>string</string>
        </response>
        <Status>string</Status>
        <TrakingCode>string</TrakingCode>
        <ErrorCode>string</ErrorCode>
        <JurnalNumber>string</JurnalNumber>
        <TrransactionDate>string</TrransactionDate>
        <Extera>string</Extera>
        <Description>string</Description>
      </PayaTransactionResult>
      <response>
        <string>string</string>
        <string>string</string>
      </response>
    </PayaTransactionResponse>
  </soap12:Body>
</soap12:Envelope>