- KnowSystem
- 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.
- 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 and quering 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 Message
Request
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>
<V_XML Version="2.0" CertificateID="cf4b7e7a-4fec-43b4-a2cb-221263c0a34b"
ProductType="Enterprise" ProductVersion="iVeriWebService" Direction="Request">
<Transaction ApplicationID="e7c523a4-7da7-4e59-b888-569fe65c535b" Command="Debit" Mode="Test">
<MerchantTrace>240X5681EEE</MerchantTrace>
<Amount>2000</Amount>
<Currency>ZAR</Currency>
<ExpiryDate>042024</ExpiryDate>
<MerchantReference>20220104.14:31</MerchantReference>
<CardSecurityCode>183</CardSecurityCode>
<PAN>4242424242424242</PAN>
</Transaction></V_XML>
</request>
</Execute>
</soap:Body>
</soap:Envelope>
Response
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><V_XML Version="2.0" Direction="Response">
<Transaction ApplicationID="{E7C523A4-7DA7-4E59-B888-569FE65C535B}" Command="Debit" Mode="Test" RequestID="{E7AF107F-C9F6-4086-927D-935368B504EE}">
<Result Status="0" Code="0" Description="" AppServer="105IVERIAPPPR1N" DBServer="105iveridbpr01n" Gateway="Nedbank" AcquirerCode="00" AcquirerDescription="" />
<MerchantTrace>240X5681EEE</MerchantTrace>
<Amount>2000</Amount>
<AuthorisationCode>311507</AuthorisationCode>
<CCNumber>4242........4242</CCNumber>
<Currency>ZAR</Currency>
<ExpiryDate>042024</ExpiryDate>
<MerchantReference>20220104.14:31</MerchantReference>
<Terminal>Default</Terminal>
<TransactionIndex>{E5E2E178-4B2D-4DD2-82F1-B26DCD34FCBE}</TransactionIndex>
<MerchantName>iVeri Payment Technology</MerchantName>
<MerchantUSN>7771777</MerchantUSN>
<Acquirer>NBPostilionNBSouthAfrica</Acquirer>
<AcquirerReference>95707:04645632</AcquirerReference>
<AcquirerDate>20230103</AcquirerDate>
<AcquirerTime>143147</AcquirerTime>
<DisplayAmount>R 20.00</DisplayAmount>
<BIN>4</BIN>
<Association>VISA</Association>
<CardType>Unknown CardType</CardType>
<Issuer>Unknown Issuer</Issuer>
<Jurisdiction>International</Jurisdiction>
<PAN>4242........4242</PAN>
<PANMode>Keyed</PANMode>
<ReconReference>04645632</ReconReference>
<CardHolderPresence>CardNotPresent</CardHolderPresence>
<MerchantAddress>MERCHANT ADDRESS</MerchantAddress>
<MerchantCity>Sandton</MerchantCity>
<MerchantCountryCode>ZA</MerchantCountryCode>
<MerchantCountry>South Africa</MerchantCountry>
<DistributorName>Nedbank</DistributorName>
</Transaction>
</V_XML></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 |
Transaction History Download
Request
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>
<File Command="TRANSACTIONHISTORY">
<Gateway>Nedbank</Gateway>
<CertificateID>{2bc42c-7ffb-44d0-a1e4-441444e1274c}</CertificateID>
<UserGroup>3**816</UserGroup>
<UserName>administrator</UserName>
<Password>$C***n</Password>
<FileName>TransactionHistory.zip</FileName>
<Mode>Test</Mode>
<StartDateTime>2022-11-01T10:00:00</StartDateTime>
<EndDateTime>2022-11-02T11:00:00</EndDateTime>
<Format>XML</Format></File>
</fileServiceCommand>
</DownloadFile>
</env:Body>
</env:Envelope>
Response
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
Request
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
<env:Header/><env:Body>
<DownloadFile xmlns="http://iveri.com/">
<fileServiceCommand>
<File Command="RECON">
<Gateway>Nedbank</Gateway>
<CertificateID>{12bc42c-7ffb-44d0-a1e4-441444e1274c}</CertificateID>
<UserGroup>256146</UserGroup>
<UserName>Bu****H</UserName>
<Password> K******NS</Password>
<FileName>Recon.zip</FileName>
<AcquirerCycle>02463</AcquirerCycle>
<Mode>Test</Mode>
<Acquirer>NBPostilionNBSouthAfrica</Acquirer>
<MerchantUsn>0092201</MerchantUsn>
<Format>XML</Format>
</File>
</fileServiceCommand>
</DownloadFile>
</env:Body>
</env:Envelope>
Response
<?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 Message
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
<env:Header/>
<env:Body>
<UploadFile xmlns="http://iveri.com/">
<fileServiceCommand>
<File Command="BATCH">
<Gateway>Nedbank</Gateway>
<CertificateID>{00000000-0000-0000-0000-0000000000000}</CertificateID>
<UserGroup>000006</UserGroup>
<UserName>Administrator</UserName>
<FileName>****</FileName>
<Password>S*****3</Password></File>
</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<?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>
<DownloadFileResponse xmlns="http://iveri.com/"> <DownloadFileResult>
UEsDBBQAAggIAHibPFc737XWRwIAAIIGAAAEABQAQnVzaV
JYEABSYngxAQAIAAAAAAAAAAAAxZVZa+s4FMe/SvC76m
PtGhSDFhsK01LSUOatuIlKDYndeuEOlH73UZw06QJDL3fLS
3Q26c///Ej0ze0/F3/PbkLX120zT/AZJDNfd2E1TPEi9I9t04ck
17YaVg8z1263VbOeJ1Po22/Npq3WScyPzRDnk5nZHo4AEM
fKehOaahtyO/a1To+h9tUQcgyYAAGs0yncP3I+hO3MPD5u6lW
1k3Hu58mztSAFKSwCpwSi1jOkaGkRMc4LbAowhLwks4t2Heb
JMvRDctLqw10d40V4GmNhug5oCcQVElGQClESb1KOMySxtM
ClLK33L1H+MnTbuqk2uU5Px4vQrR6qZliE+9CFZhVyILdY6PR
zQUcHx81wPVTD2LsoLkeZ1OmnrL4ad6N9eLUlywCITt+lj03L
OjqYCcIATi1TUu/tz+N0LB0C7dzluL0LXU4xxWeHz+6s02NJm
3F4aLu6nzyfRDGuJGAV7/lU0suuavpqwuS8WYd/82fOLSfCY
SSMcIiykiFjqEKeMyeF8qow7CXa+HFQm9XTGJHr8kt71fZDv
YmlS3vdxkfNfRchiAJeW47NJ4sVE5z9BZRLyDicet8s4TX1gbl3
6WPTwVz2rmVv7iKs2ma/tRx2WzyF+9obIo56PhR0eoT8N/Kun
FTYloDKkkHkPaPIEFyguBprysxbVYjv4p24qlszLr9IPXyF+cNa/ijz
mIiMsy8i74qMCgYOcSbirwhXFFkoCOLYU8yYZODhVyPP1M9DH
lP2w8jv9Pwf8vtz/J7+evL/
/8mnGjHy2QEAAAAAAAAAAAAAAAAAAAAAUEsFBgAAAA
ABAAEAVgAAAH0CAAAAAA==
</DownloadFileResult>
</DownloadFileResponse>
</soap:Body>
</soap: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 Message
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
<env:Header/><env:Body>
<IsDataAvailable xmlns="http://iveri.com/">
<fileServiceCommand>
<File Command="BATCH">
<Gateway>Nedbank</Gateway>
<CertificateID>{bc42c-7ffb-44d0-a1e4-441444e1274c}</CertificateID>
<ApplicationID>{b0873eb-0c97-4bd5-94fb-3acd72ae0a33}</ApplicationID>
<UserGroup>25***46</UserGroup>
<UserName>Administrator</UserName>
<Password>S******</Password>
<FileName>Test</FileName>
<Mode>Test</Mode>
<Format>XML</Format></File>
</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><?xml version="1.0" encoding="utf-8" ?>
<File><Result Status="101" Description="File not found"/></File>
</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 Message
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>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 Message
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
Response
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 Message
Request
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>
Response
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>
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 message
Request
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>
Response
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 Message
Request
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>
Response
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>