Execute - (bool validateRequest, string protocol, string protocolVersion, string request)
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> <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>
|
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: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 (string fileServiceCommand)
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> <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>
|
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> <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>
|
<?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>
|