-
Introduction
-
Commands & Actions
-
Transaction Sequence
-
MasterPass
-
Visa Checkout
-
Foreign Exchange
-
Parameter Description & Action
-
Gateway Domain Knowledge
-
Transaction Result Codes
-
Out Of Band
-
Payment Facilitator
-
Tokenization
-
SOAP API
-
Pos Device Intergration
-
Acquire Contact Information
-
3D Secure
-
Enterprise API Samples
-
Card on File
-
Additional Data Transactions
The examples apply when using the web service interface to perform various transactions. The examples serve to showcase a set of parameters that are largely used when performing transactions using the schema definition available in the SOAP interface. The same functionality is available in the REST API
For further insights on the transaction types and their meanings,
refer to the “Commands” and
“Actions” sections and these have to be used
in conjunction with the input parameters per actions. For the corresponding
transaction flows per transactions type refer to transaction sequence
The examples cover the following messages:
The transaction Request and Response cover the following:
- The Request message shows all the elements that are mostly used. The examples that follow will use the mandatory elements from this message necessary to perform the respective transaction covered in the example.
- · The response message is a typical response received from the web service to the various request messages.
Sale – “Debit with PAN”
This where the cardholder is debited, and the merchant account is credited by the acquiring bank or PSP that holds the merchant agreement.
REST |
SOAP |
Request |
|
{ "Version": "2.0", "CertificateID": "{5c4b9c74-0063-4240-9cff-f730675c5bd0}", "ProductType": "Enterprise", "ProductVersion": "WebAPI", "Direction": "Request", "Transaction": { "ApplicationID": "{d8d5a94-8fa0-428d-a539-3a5baf166f7f}", "Command": "Debit", "Mode": "TEST", "MerchantReference": "20221108_1029", "MerchantTrace": "DIAAAY4734", "Currency": "ZAR", "Amount": "3000", "ExpiryDate": "1025", "PAN": "4242424242424242"
} }
|
<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="7c523a4-7da7-4e59-b888-569fe65c535b" Command="Debit" Mode="Test"> <MerchantTrace>2407E27568BEEE</MerchantTrace> <Amount>2000</Amount> <Currency>ZAR</Currency> <ExpiryDate>042024</ExpiryDate> <MerchantReference>20220104.0942 </MerchantReference> <CardSecurityCode>183</CardSecurityCode> <PAN>4242424242424242</PAN> </Transaction></V_XML> </request> </Execute> </soap:Body> </soap:Envelope> |
Response |
|
{ "Version": "2.0", "Direction": "Response", "Transaction": { "MerchantTrace": "DIAAAY4734", "Amount": "3000", "AuthorisationCode": "543305", "CCNumber": "4242........4242", "Currency": "ZAR", "ExpiryDate": "102025", "MerchantReference": "20221108_1029", "Terminal": "Default", "TransactionIndex": "{7C256903-9097-41AE-81B6-54681B33301F}", "MerchantName": "iVeri Payment Technology", "MerchantUSN": "7771777", "Acquirer": "NBPostilionNBSouthAfrica", "AcquirerReference": "95702:04641684", "AcquirerDate": "20221229", "AcquirerTime": "102825", "DisplayAmount": "R 30.00", "BIN": "4", "Association": "VISA", "CardType": "Unknown CardType", "Issuer": "Unknown Issuer", "Jurisdiction": "International", "PAN": "4242........4242", "PANMode": "Keyed", "ReconReference": "04641684", "CardHolderPresence": "CardNotPresent", "MerchantAddress": "MERCHANT ADDRESS", "MerchantCity": "Sandton", "MerchantCountryCode": "ZA", "MerchantCountry": "South Africa", "DistributorName": "Nedbank", "ApplicationID": "{D8D5A94-8FA0-428D-A539-3A5BAF166F7F}", "Command": "Debit", "Mode": "Test", "RequestID": "{B6308E50-4337-4DFE-A0DC-A4B3C4732139}", "Result": { "Status": "0", "Code": "0", "Description": "", "AppServer": "105IVERIAPPPR2N", "DBServer": "105iveridbpr01n", "Gateway": "Nedbank", "AcquirerCode": "00", "AcquirerDescription": "" } } }
|
<?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= "{7C523A4-7DA7-4E59-B888-569FE65C535B}" Command="Debit" Mode="Test" RequestID="{E01B8439-05B0-4B68-A22F-903D8CB5CC67}"> <Result Status="0" Code="0" Description="" AppServer="105IVERIAPPPR1N" DBServer= "105iveridbpr01n" Gateway="Nedbank" AcquirerCode="00" AcquirerDescription="" /> <MerchantTrace>2407E27568BEEE</MerchantTrace> <Amount>2000</Amount> <AuthorisationCode>540565</AuthorisationCode> <CCNumber>4242........4242</CCNumber> <Currency>ZAR</Currency> <ExpiryDate>042024</ExpiryDate> <MerchantReference>20220104.0942 </MerchantReference> <Terminal>Default</Terminal> <TransactionIndex>{F20B545A-B2CC-40E9-8C9B-40030AC50B31}</TransactionIndex> <MerchantName>iVeri Payment Technology </MerchantName> <MerchantUSN>7771777</MerchantUSN> <Acquirer>NBPostilionNBSouthAfrica</Acquirer> <AcquirerReference>95702:04641678 </AcquirerReference> <AcquirerDate>20221229</AcquirerDate> <AcquirerTime>094245</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>04641678</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>
|