2. KnowSystem
  3. SOAP API

SOAP API

Web Service implementation

 

All methods provided by the web service return a V_XML formatted response. The GetPinBlock method is the only exception. For card present transactions, the GetPinBlock method will return a PINBlock data structure.


  • The V_XML request and response format is defined by the V_XML.xsd schema, which can be downloaded from https://portal.nedsecure.co.za/schemas/v_xml/7.0/v_xml.xsd
  • Client code must check the respective Result fields to determine if the web service method was successful or not. (Result fields are defined by the V_XML specification)
  • For a client to call the execute method the client certificate ID must be provided with the HTTP Request



Webservice Gateway Address

 

SOAP Webservic EndPoints

Purpose

Usage

Live and Test:  /iVeriWebservice/Service.asmx

HTTP Method: POST

Submit transactions to iVeri Gateway endpoint  

 

1.      Mandatory: Card processing transactions to the Gateway

2.      Optional: Querying Transaction Status

 


Service Description

SOAP Webservic EndPoints

Purpose

 Comment

Nedbank Hosted : https://portal.nedsecure.co.za/iVeriWebService/Service.asmx?wsdl

Contains all functions supported by the iVeri SOAP webservice

 

 

iVeri Hosted

https://portal.host.iveri.com/iVeriWebService/Service.asmx?wsdl

Contains all functions supported by the iVeri SOAP webservice

 

 

Message Formats

 

Communication between the client and web service is via SOAP protocol. Format supported is in XML.The SOAP requests and responses are shown for each method provided by the web service.

WebService Methods

Execute

 

Usage: For posting of transactions to the Gateway

Description

Execute

Execute the V_XML formatted request. The action to be performed is determined by the V_XML, as defined by the V_XML specifications.

 

ie. Transaction (Sale, Refund etc)

Returns

A V_XML formatted string (The return string will need to be URL decoded)

Client Certificate

Is required (provided with HTTP Request)

Parameters

ValidateRequest: boolean

true:

Will validate the V_XML request against the schema definition. If there are any schema errors processing of the request will terminate and the request will not be passed on to the relevant provider.

or

false:

Will not validate the V_XML request.

The V_XML request along with any schema errors will be passed on to the relevant provider for processing. If there are schema errors processing will terminate in the provider.

 

Set this parameter to true while testing client code and false when in a production environment.

Protocol: string

Currently supported protocols

•        V_XML

 

If validate is set to true, an unsuccessful response will be generated for any unsupported values.

ProtocolVersion: string

Currently supported protocol version

•        "7.0" (V_XML)

 

If validate is set to true, an unsuccessful response will be generated for any unsupported values.

Request: string

A V_XML format string without any namespace declarations. Providing namespace declarations will result in an unsuccessful call.

 

The request must also be URL encoded

 

Additional

Validation Performed

The execute method will also return unsuccessful if:

 

•        No client certificate present

•        Certificate ID not provided in the V_XML request

•        Certificate ID in the Client Certificate does not match the Certificate ID in the V_XML

 

Validation of the Client Certificate is always performed.

 

 

Note: URL Encode / Decode is not necessary in .NET and PHP

Execute SOAP Message

 

Request

Response

POST /iVeriWebService/Service.asmx HTTP/1.1

Host: portal.nedsecure.co.za

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

<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>

  <Execute xmlns="http://iveri.com/">

  <validateRequest>false</validateRequest>

  <protocol>V_XML</protocol>

  <protocolVersion>7.0</protocolVersion>

  <request>

    &lt;V_XML Version="2.0" CertificateID="cf4b7e7a-4fec-43b4-a2cb-221263c0a34b" 

    ProductType="Enterprise" ProductVersion="iVeriWebService" Direction="Request"&gt;

    &lt;Transaction ApplicationID="e7c523a4-7da7-4e59-b888-569fe65c535b" Command="Debit" Mode="Test"&gt;

    &lt;MerchantTrace&gt;240X5681EEE&lt;/MerchantTrace&gt;

    &lt;Amount&gt;2000&lt;/Amount&gt;

    &lt;Currency&gt;ZAR&lt;/Currency&gt;

    &lt;ExpiryDate&gt;042024&lt;/ExpiryDate&gt;

    &lt;MerchantReference&gt;20220104.14:31&lt;/MerchantReference&gt;

    &lt;CardSecurityCode&gt;183&lt;/CardSecurityCode&gt;

    &lt;PAN&gt;4242424242424242&lt;/PAN&gt;

    &lt;/Transaction&gt;&lt;/V_XML&gt;

</request>

  </Execute>

  </soap:Body>

  </soap:Envelope>

 

 

HTTP: 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <soap:Body>

        <ExecuteResponse xmlns="http://iveri.com/">

            <ExecuteResult>&lt;V_XML Version="2.0" Direction="Response"&gt;

  &lt;Transaction ApplicationID="{E7C523A4-7DA7-4E59-B888-569FE65C535B}" Command="Debit" Mode="Test" RequestID="{E7AF107F-C9F6-4086-927D-935368B504EE}"&gt;

    &lt;Result Status="0" Code="0" Description="" AppServer="105IVERIAPPPR1N" DBServer="105iveridbpr01n" Gateway="Nedbank" AcquirerCode="00" AcquirerDescription="" /&gt;

    &lt;MerchantTrace&gt;240X5681EEE&lt;/MerchantTrace&gt;

    &lt;Amount&gt;2000&lt;/Amount&gt;

    &lt;AuthorisationCode&gt;311507&lt;/AuthorisationCode&gt;

    &lt;CCNumber&gt;4242........4242&lt;/CCNumber&gt;

    &lt;Currency&gt;ZAR&lt;/Currency&gt;

    &lt;ExpiryDate&gt;042024&lt;/ExpiryDate&gt;

    &lt;MerchantReference&gt;20220104.14:31&lt;/MerchantReference&gt;

    &lt;Terminal&gt;Default&lt;/Terminal&gt;

    &lt;TransactionIndex&gt;{E5E2E178-4B2D-4DD2-82F1-B26DCD34FCBE}&lt;/TransactionIndex&gt;

    &lt;MerchantName&gt;iVeri Payment Technology&lt;/MerchantName&gt;

    &lt;MerchantUSN&gt;7771777&lt;/MerchantUSN&gt;

    &lt;Acquirer&gt;NBPostilionNBSouthAfrica&lt;/Acquirer&gt;

    &lt;AcquirerReference&gt;95707:04645632&lt;/AcquirerReference&gt;

    &lt;AcquirerDate&gt;20230103&lt;/AcquirerDate&gt;

    &lt;AcquirerTime&gt;143147&lt;/AcquirerTime&gt;

    &lt;DisplayAmount&gt;R 20.00&lt;/DisplayAmount&gt;

    &lt;BIN&gt;4&lt;/BIN&gt;

    &lt;Association&gt;VISA&lt;/Association&gt;

    &lt;CardType&gt;Unknown CardType&lt;/CardType&gt;

    &lt;Issuer&gt;Unknown Issuer&lt;/Issuer&gt;

    &lt;Jurisdiction&gt;International&lt;/Jurisdiction&gt;

    &lt;PAN&gt;4242........4242&lt;/PAN&gt;

    &lt;PANMode&gt;Keyed&lt;/PANMode&gt;

    &lt;ReconReference&gt;04645632&lt;/ReconReference&gt;

    &lt;CardHolderPresence&gt;CardNotPresent&lt;/CardHolderPresence&gt;

    &lt;MerchantAddress&gt;MERCHANT ADDRESS&lt;/MerchantAddress&gt;

    &lt;MerchantCity&gt;Sandton&lt;/MerchantCity&gt;

    &lt;MerchantCountryCode&gt;ZA&lt;/MerchantCountryCode&gt;

    &lt;MerchantCountry&gt;South Africa&lt;/MerchantCountry&gt;

    &lt;DistributorName&gt;Nedbank&lt;/DistributorName&gt;

  &lt;/Transaction&gt;

&lt;/V_XML&gt;</ExecuteResult>

        </ExecuteResponse>

    </soap:Body>

</soap:Envelope>

 

 

 

DownloadFile Method 

Usage: For downloading files from the Gateway

 

Description

fileServiceCommand

Downloads a file

 

Returns

A Base64 encoded string which is the contents of the downloaded zipped file.

 

 

Client Certificate

Send as parameter

Parameters

See section File Transfer Parameters

DownloadFile SOAP Message

 

Request

Response

Transaction History Download

POST /iVeriWebService/Service.asmx HTTP/1.1

Host: portal.nedsecure.co.za

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">

<env:Header/>

<env:Body>

<DownloadFile xmlns="http://iveri.com/">

<fileServiceCommand>

&lt;File Command=&quot;TRANSACTIONHISTORY&quot;&gt;

&lt;Gateway&gt;Nedbank&lt;/Gateway&gt;

&lt;CertificateID&gt;{2bc42c-7ffb-44d0-a1e4-441444e1274c}&lt;/CertificateID&gt;

&lt;UserGroup&gt;3**816&lt;/UserGroup&gt;

&lt;UserName&gt;administrator&lt;/UserName&gt;

&lt;Password&gt;$C***n&lt;/Password&gt;

&lt;FileName&gt;TransactionHistory.zip&lt;/FileName&gt;

&lt;Mode&gt;Test&lt;/Mode&gt;

&lt;StartDateTime&gt;2022-11-01T10:00:00&lt;/StartDateTime&gt;

&lt;EndDateTime&gt;2022-11-02T11:00:00&lt;/EndDateTime&gt;

&lt;Format&gt;XML&lt;/Format&gt;&lt;/File&gt;

</fileServiceCommand>

</DownloadFile>

</env:Body>

</env:Envelope>

 

POST /iVeriWebService/Service.asmx HTTP/1.1

Host: portal.nedsecure.co.za

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <soap:Body>

        <DownloadFileResponse xmlns="http://iveri.com/">

            <DownloadFileResult>UEsDBBQAAggIAPV2I1aSB0HNoKIBAHQHDAAWABQAVHJhbnNhY3Rpb25IaXN0b3J5LnhtbFJYEABSYngxAQAIAAAAAAAAAAAA7H1pUxvJ0vVfIfzVt4falzcwEVVd1Rizr7b58oYsySDQgiVkG9+4//05JYHBY0Dd0gwgwr7PM4GkUiOaIk9lnpMnlw7//4eN9YXDZn/Q6nXfvGJ/kVcLodVv1i9Gj3ebg/Ned9B8tby026z3umlx3ht2L968kpTh2f1+rTuojVYvuPPzdqteS1+vhjev/it4YJH6PJMF05nQmmRWOZtJZymlRcgVl/97tbDRazTfvFpvfW2+wrU7nVq38eZVaH5qXbxa2G1+GTYHF6PLEaIVITZkXhKTCZ/HzClVZKJQSuU540LE/+EjbQ/79ZPaoBlqF81lRhijlLClxV+e/rlov9VpLhMjCSE3S0ZPLm0006PuBX7EenP5v8Lmmjoj8O356NsXmSmIzgotheHEUhn1/5YWf33X7fuz2m00vy//N +gCZYfEgGgBQSwECLQAUAAIICAD1diNWkgdBzaCiAQB0BwwAFgAkAAAAAAAAAIAAAAAAAAAAVHJhbnNhY3Rpb25IaXN0b3J5LnhtbAoAIAAAAAAAAQAYAPL5+69yH9kBAAAAAAAAAAAAAAAAAAAAAFBLBQYAAAAAAQABAGgAAADoogEAAAA=</DownloadFileResult>

        </DownloadFileResponse>

    </soap:Body>

</soap:Envelope>

 

 

Recon Download Sample

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">

<env:Header/><env:Body>

<DownloadFile xmlns="http://iveri.com/">

         <fileServiceCommand>

                &lt;File Command=&quot;RECON&quot;&gt;

                &lt;Gateway&gt;Nedbank&lt;/Gateway&gt;

                &lt;CertificateID&gt;{12bc42c-7ffb-44d0-a1e4-441444e1274c}&lt;/CertificateID&gt;

                &lt;UserGroup&gt;256146&lt;/UserGroup&gt;

                &lt;UserName&gt;Bu****H&lt;/UserName&gt;

                &lt;Password&gt K******NS&lt;/Password&gt;

                &lt;FileName&gt;Recon.zip&lt;/FileName&gt;

                &lt;AcquirerCycle&gt;02463&lt;/AcquirerCycle&gt;

                &lt;Mode&gt;Test&lt;/Mode&gt;

                &lt;Acquirer&gt;NBPostilionNBSouthAfrica&lt;/Acquirer&gt;

                &lt;MerchantUsn&gt;0092201&lt;/MerchantUsn&gt;

                &lt;Format&gt;XML&lt;/Format&gt;

                &lt;/File&gt;

</fileServiceCommand>

</DownloadFile>

</env:Body>

</env:Envelope>

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <soap:Body>

        <DownloadFileResponse xmlns="http://iveri.com/">

            <DownloadFileResult>UEsDBBQAAggIAKl1JVZmVbJ6TQAAAEgAAAAJABQAUmVjb24ueG1sUlgQAFJieDEBAAgAAAAAAAAAAAABSAC3/zxWX1hNTCBWZXJzaW9uPSIyLjAiIERpcmVjdGlvbj0iUmVzcG9uc2UiPjxSZWNvblhNTCBDb3VudD0iMCIgLz48L1ZfWE1MPlBLAQItABQAAggIAKl1JVZmVbJ6TQAAAEgAAAAJACQAAAAAAAAAgAAAAAAAAABSZbi54bWwKACAAAAAAAAEAGAAXnhiRAyHZAQAAAAAAAAAAAAAAAAAAAABQSwUGAAAAAAEAAQBbAAAAiAAAAAAA</DownloadFileResult>

        </DownloadFileResponse>

    </soap:Body>

</soap:Envelope>

 

 

UploadFile 

 

Usage: Upload Batch files to the iVeri Gateway

 

Description

fileServiceCommand

Uploads file

 

 

Returns

Result Status Code and Description

Parameters

Client Certificate

Send as parameter

Parameters

See section File Transfer Parameters

UploadFile SOAP Message

 

Request

Response

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">

    <env:Header/>

    <env:Body>

        <UploadFile xmlns="http://iveri.com/">

            <fileServiceCommand>

                &lt;File Command=&quot;BATCH&quot;&gt;

                &lt;Gateway&gt;Nedbank&lt;/Gateway&gt;

  &lt;CertificateID&gt;{00000000-0000-0000-0000-0000000000000}&lt;/CertificateID&gt;

  &lt;UserGroup&gt;000006&lt;/UserGroup&gt;

  &lt;UserName&gt;Administrator&lt;/UserName&gt;

  &lt;FileName&gt;****&lt;/FileName&gt;

  &lt;Password&gt;S*****3&lt;/Password&gt;&lt;/File&gt;           

          </fileServiceCommand>

           <fileData>

   PFZfWE1MIFZlcnNpb249IjIuMCIgRGlyZWN0aW9uPSJSZXF1ZXN0Ij

4gDQogIDxCYXRjaCBWZXJzaW9uPSIyLjAiIENvbW1hbmQ9IkJhdGNoVXBs

b2FkIiBDb3VudD0iMSIgQW1vdW50PSIxMDAwIj4gDQoJCTxEYXRlPjIwMjAxMTA2

PC9EYXRlPiANCgkJPEZpbGVuYW1lPkJ1c2lUZXN0QXBwbGljYXRpb24xPC9Ga

WxlbmFtZT4gDQoJCTxEZXNjcmlwdGlvbj5XZWRuZXNkYXlMb2FkPC9EZXNjcm

lwdGlvbj4gDQoJCTxCYXRjaEl0ZW0gQXBwbGljYXRpb25JRD0ie2JiMDg3M2ViLTBjOTctNGJkNS05NGZiLTNhY2Q3MmFlMGEz

M30iIE1vZGU9IlRlc3QiIENvbW1hbmQ9IlJlY3VycmluZ0RlYml0Ij4gDQoJCQk8Q0NOdW1iZXI+NDI0Mi4uLi4uLi4uNDI0MjwvQ0NOdW1iZXI+IA0KCQkJPFN0YXJ0RGF0ZT4xMTIwMjA8L1N0YX

J0RGF0ZT4NCgkJCTxFeHBpcnlEYXRlPjEyMjAyMDwvRXhwaXJ5RGF0Z

T4NCgkJCTxCdWRnZXRQZXJpb2Q+PC9CdWRnZXRQZX

Jpb2Q+IA0KCQkJPFRlcm1pbmFsPjQ3ODUyMzI2PC9UZXJtaW5

hbD4NCgkJCTxBbW91bnQ+MTAwMDwvQW1vdW50Pg0KCQkJPEN1cnJlbmN5PlpBUjwvQ3

VycmVuY3k+IA0KCQkJPE1lcmNoYW50UmVmZXJlbmNlPk9uVGhlR09XZ

WRUZXN0aW5nRnJpZGF5PC9NZXJjaGFudFJlZmVyZW5jZT4gDQoJCQk

8UHVyY2hhc2VEYXRlPjIwMjAxMTA0PC9Q

dXJjaGFzZURhdGU+IA0KCQkJPFB1cmNoYXNlVGltZT4wOTEwMTk8L1B

1cmNoYXNlVGltZT4gDQoJCQk8VHJhbnNhY3Rpb25JbmRleD57MkE2N

EI5NkQtNDkyRC00Njc4LUJFRjgtRDUyNEYyNjlBRjFGfTwvVHJhbnNhY3Rpb25JbmRleD4NCgkJPC9CYXRjaEl0ZW

0+DQoJPC9CYXRjaD4gDQo8L1ZfWE1MPg==

          </fileData>

        </UploadFile>

    </env:Body>

</env:Envelope>

 

IsDataAvailable 

 

Usage: Check if Batch result file is available on the iVeri Gateway, works hand in hand with the UploadFile method

 

Description

IsDataAvailable

Check the availability of the Batch result file

 

 

Returns

Result Status Code and Description

Parameters

Client Certificate

Send as parameter

Parameters

See section File Transfer Parameters

IsDataAvailable SOAP Message

 

Request

Response

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">

<env:Header/><env:Body>

<IsDataAvailable xmlns="http://iveri.com/">

         <fileServiceCommand>

                &lt;File Command=&quot;BATCH&quot;&gt;

                &lt;Gateway&gt;Nedbank&lt;/Gateway&gt;

                &lt;CertificateID&gt;{bc42c-7ffb-44d0-a1e4-441444e1274c}&lt;/CertificateID&gt;

                &lt;ApplicationID&gt;{b0873eb-0c97-4bd5-94fb-3acd72ae0a33}&lt;/ApplicationID&gt;

                &lt;UserGroup&gt;25***46&lt;/UserGroup&gt;

                &lt;UserName&gt;Administrator&lt;/UserName&gt;

                &lt;Password&gt;S******&lt;/Password&gt;

                &lt;FileName&gt;Test&lt;/FileName&gt;            

                &lt;Mode&gt;Test&lt;/Mode&gt;

                &lt;Format&gt;XML&lt;/Format&gt;&lt;/File&gt;

</fileServiceCommand>

</IsDataAvailable>

</env:Body>

</env:Envelope>

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <soap:Body>

        <IsDataAvailableResponse xmlns="http://iveri.com/">

            <IsDataAvailableResult>&lt;?xml version="1.0" encoding="utf-8" ?&gt;

&lt;File&gt;&lt;Result Status="101" Description="File not found"/&gt;&lt;/File&gt;

</IsDataAvailableResult>

        </IsDataAvailableResponse>

    </soap:Body>

</soap:Envelope>

 

GenerateCertificateID 


GenerateCertificateID

Creates a new unique Certificate ID to be used when generating a new certificate signing request. Certificate status will be created. This method must be used in conjunction with the SubmitCertificateRequest method to complete request of a new certificate.

Returns

A V_XML formatted string containing the generated certificate ID.

Client Certificate

not required

Parameters

billingDetailsID: string

Merchant Profile ID /User Group ID

 

 

GenerateCertificateID SOAP Message

 

Request

Response

<?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>

    <GenerateCertificateID xmlns="http://iveri.com/">

      <billingDetailsID>string</billingDetailsID>

    </GenerateCertificateID>

  </soap:Body>

</soap:Envelope>

 

 

<?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>

    <GenerateCertificateIDResponse xmlns="http://iveri.com/">

      <GenerateCertificateIDResult>string</GenerateCertificateIDResult>

    </GenerateCertificateIDResponse>

  </soap:Body>

</soap:Envelope>

 

 

 

GenerateCertificateID SOAP Message

 

Request

Response

<?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>

    <GenerateCertificateID xmlns="http://iveri.com/">

      <billingDetailsID>string</billingDetailsID>

    </GenerateCertificateID>

  </soap:Body>

</soap:Envelope>

 

 

<?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>

    <GenerateCertificateIDResponse xmlns="http://iveri.com/">

      <GenerateCertificateIDResult>string</GenerateCertificateIDResult>

    </GenerateCertificateIDResponse>

  </soap:Body>

</soap:Envelope>

 

 

 

GetCertificate

 

Description

 

GetCertificate

Download a base 64 encoded P7B certificate that has been issued

Returns

A V_XML formatted string (The return string will need to be URL decoded) containing the

Client Certificate

not required

Parameters

 

certificateID:string

Certificate ID (GUID) used to generate the certificateSigningRequest

GetCertificate SOAP Message

 

Request

Response

 

POST /iVeriWebService/Service.asmx HTTP/1.1

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://iveri.com/GetCertificate"

 

<?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>

    <GetCertificate xmlns="http://iveri.com/">

      <certificateID>string</certificateID>

    </GetCertificate>

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

    <GetCertificateResponse xmlns="http://iveri.com/">

      <GetCertificateResult>string</GetCertificateResult>

    </GetCertificateResponse>

  </soap:Body>

</soap:Envelope>

RenewCertificateID 

 

Usage: Renewal of an existing certificate

Description

RenewCertificateID

Will change the certificate status of the certificate mathcing the certificate ID to "created". This method must be used in conjunction with the SubmitCertificateRequest method to complete the renewal of the certificate.

Returns

A V_XML formatted string (The return string will need to be URL decoded)

Client Certificate

not required

Parameters

certificateID: string

Certificate ID (GUID) of existing certificate.


RenewCertificateID Sample Message

 

Request

Response

 

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://iveri.com/RenewCertificateID"

 

<?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>

    <RenewCertificateID xmlns="http://iveri.com/">

      <billingDetailsID>string</billingDetailsID>

      <certificateID>string</certificateID>

    </RenewCertificateID>

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

    <RenewCertificateIDResponse xmlns="http://iveri.com/">

      <RenewCertificateIDResult>string</RenewCertificateIDResult>

    </RenewCertificateIDResponse>

  </soap:Body>

</soap:Envelope>

 

 

 

PinBlock GetPinBlock 


Description

 

Generate a PIN Block using the HSM (Hardware Security Module)

Returns

 

PinBlock data structure containing the following fields:

 

•        ResultStatusCode

•        ResultDescription

•        DeviceSerialNumber

•        DeviceMake

•        KeySerialNumber

•        PinBlock

 

ResultStatusCode see Status Codes used by V_XML

ResultDescription see Descriptions used by V_XML

Client Certificate

 

 

not required

 

 

Parameters

mode

: string

"test"

 

"live"

 

 

pan

: string

Primary Account Number

pin

: string

 

Additional

Validation Performed

•        pan length is not less than 13 chracters and not more than 19 characters

•        pan is also validated against the LUHN Formula

•        pin length is not less than 4 characters and not more than 14 characters

GetPinBlock SOAP message

 

Request

Response

POST /iVeriWebService/Service.asmx

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://iveri.com/GetPinBlock"

 

<?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>

    <GetPinBlock xmlns="http://iveri.com/">

      <mode>string</mode>

      <pan>string</pan>

      <pin>string</pin>

    </GetPinBlock>

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

    <GetPinBlockResponse xmlns="http://iveri.com/">

      <GetPinBlockResult>

        <ResultStatusCode>int</ResultStatusCode>

        <ResultDescription>string</ResultDescription>

        <DeviceSerialNumber>string</DeviceSerialNumber>

        <DeviceMake>string</DeviceMake>

        <KeySerialNumber>string</KeySerialNumber>

        <PinBlock>string</PinBlock>

      </GetPinBlockResult>

    </GetPinBlockResponse>

  </soap:Body>

</soap:Envelope>

 

SubmitCertificate 

 

Description

SubmitCertificateRequest

Submits a PKCS10 certificate signing request. Certificate status will be pending.

Returns

A V_XML formatted string.

Client Certificate

not required

Parameters

certificateID

: string

Certificate ID (GUID) used to generate the certificateSigningRequest

certificateSigningRequest

: string

 

 

Base 64 encoded string containing the new certificate signing request

 

example of a certificate signing request

BEGIN NEW CERTIFICATE REQUEST-----

MIIDGjCCAoMCAQAwgbMxCzAJBgNVBAYTAlpBMRAwDgYDVQQIDAdHYXV0ZW5nMRAwINT8mTAfmAe4FdlY9RUv43F9jBYqsV/B6fQxRiSehqnOeS4pmK5gIXiqmfgA/NmZqRiohLwr45SNu6NjF6Bx56T9fAw7RKTsN9dYb6vEtOXew2kc

-----END NEW CERTIFICATE REQUEST-----

 

SubmitCertificate SOAP Message

 

Request

Response

POST /iVeriWebService/Service.asmx HTTP/1.1

Content-Type: text/xml;

Content-Length: length

 

 

<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>

    <SumitCertificateRequest xmlns="http://iveri.com/">

      <certificateID>string</certificateID>

      <certificateSigningRequest>string</certificateSigningRequest>

    </SumitCertificateRequest>

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

    <SumitCertificateRequestResponse xmlns="http://iveri.com/">

      <SumitCertificateRequestResult>string</SumitCertificateRequestResult>

    </SumitCertificateRequestResponse>

  </soap:Body>

</soap:Envelope>