-
Virtual POS
Virtual POS Transactions General Concepts
Garanti Virtual POS is a secure payment solution created to receive credit card payments for online sales.
Merchants can open an online branch in their stores and turn it into a sales platform that never closes with Garanti Virtual POS. This will contribute to increasing both the number of customers and turnover.
The following transactions are generally performed under Garanti Virtual POS:
- Sales Transactions
- Common Payment Page Operations
- Cancellation Procedures
- Refund Procedures
- Closing Operations
- Inquiry Procedures
In this document, the steps required for merchants to be able to provide 3D Advance Sales transactions under Garanti Virtual POS, the transactions that must be performed within each step, and the structures of the transaction requests sent and response messages received are explained.
Virtual POS Return Transactions
Virtual POS Return Transactions are divided into 2 categories:
1. Refund Transaction: It is a transaction made to reflect a transaction back to the card in full for the following days. Refund transactions appear as minus (-) movement in card statements or in-period transactions. Therefore, in the return of a transaction, the sales transaction and the return transaction appear as two separate items on the card.
2. Partial Refund: It is a transaction made to reflect a part of the amount of a transaction back to the card on the same day or in the following days. In partial refund transactions, bonuses are refunded first. When there are no more bonuses to be refunded, the amount used is refunded.
Test / Prod Environment Selections:
For Virtual POS Sales transactions, it is possible to proceed with 2 different methods by the merchant. If the merchant wishes, they can make all the improvements in the test environment. Alternatively, necessary improvements can be made for these transactions directly in the broadcast environment.
According to the method to be selected by the merchant, before starting Virtual POS sales transactions, the first transactions must be made according to the appropriate one of the following headings:
If the work to be done is carried out in a test environment, the following predefined values can be used as they are:
| Parameter | Value |
|---|---|
| MerchantID | 7000679 |
| ProvUserID | PROVAUT / PROVRFN / PROVOOS |
| ProvisionPassword | 123qweASD/ |
| TerminalID | 30691297 |
| StoreKey | 12345678 |
In the studies to be carried out in the test environment "https://sanalposprovtest.garantibbva.com.tr/VPServlet" url will be used.
A panel where the operations performed in the test environment can be monitored and displayed at this address you can access.
| Variable | Value |
|---|---|
| Kullanıcı Adı | 99999999999 |
| Passcode | Destek.1 |
| Password | 147852 |
Not: In the event of an error in the password process, please try a second time before making a second attempt. Send Us a Question Please provide information with the form.
List of all test cards that can be used in the test environment from this page you can reach.
When proceeding with this method, the passwords to be used by the merchant in the setup as the first step are (“PROVAUT”,“PROVOOS”, “PROVRFN” ve “3D” (storekey) passwords) Virtual POS First Steps virtual POS management panel as specified in the document.
Passwords and accounts created in this way will be used in the next steps.
In the studies to be carried out in PROD environment "https://sanalposprov.garanti.com.tr/VPServlet" url will be used.
Hash Algorithm
This document explains step by step how to create the data required for the <HashData> tag in the request message, which is used under many transaction types.
The <HashData> tag in the request messages is the field that allows the password verification of the user. Hash creation details are explained separately below.
In the new VirtualPoS application, the HASH structure is used to prevent the password of the terminal from circulating openly.
Hash account:
1. SHA1 in the calculation of hashedpassword information
2. SHA512 algorithm is used to calculate the hashvalue.
In the hash calculation, a two-part HASH structure is used. In the first stage, the hashedpassword value will be obtained using the SHA1 algorithm by juxtaposing the provisioning password with the terminal number.
The operations required to generate hash are presented below for different programming languages:
public static string Sha1(string text) {\n var provider = CodePagesEncodingProvider.Instance;\n Encoding.RegisterProvider(provider);\n\n var cryptoServiceProvider = new SHA1CryptoServiceProvider();\n var inputbytes = cryptoServiceProvider.ComputeHash(Encoding.GetEncoding(\"ISO-8859-9\").GetBytes(text));\n\n var builder = new StringBuilder();\n for (int i = 0; i < inputbytes.Length; i++) {\n builder.Append(string.Format(\"{0,2:x}\", inputbytes[i]).Replace(\" \", \"0\"));\n }\n\n return builder.ToString().ToUpper();\n}\n\npublic static string Sha512(string text) {\n var provider = CodePagesEncodingProvider.Instance;\n Encoding.RegisterProvider(provider);\n\n var cryptoServiceProvider = new SHA512CryptoServiceProvider();\n var inputbytes = cryptoServiceProvider.ComputeHash(Encoding.GetEncoding(\"ISO-8859-9\").GetBytes(text));\n\n var builder = new StringBuilder();\n for (int i = 0; i < inputbytes.Length; i++) {\n builder.Append(string.Format(\"{0,2:x}\", inputbytes[i]).Replace(\" \", \"0\"));\n }\n\n return builder.ToString().ToUpper();\n}\n\npublic static string GetHashData(string userPassword, string terminalId, string orderId, string cardNumber, ulong amount, int currencyCode) {\n var hashedPassword = Sha1(userPassword + \"0\" + terminalId);\n return Sha512(orderId + terminalId + cardNumber + amount + currencyCode + hashedPassword).ToUpper();\n}
Public Shared Function Sha1(ByVal text As String) As String\n Dim provider = CodePagesEncodingProvider.Instance\n Encoding.RegisterProvider(provider)\n Dim cryptoServiceProvider = New SHA1CryptoServiceProvider()\n Dim inputbytes = cryptoServiceProvider.ComputeHash(Encoding.GetEncoding(\"ISO-8859-9\").GetBytes(text))\n Dim builder = New StringBuilder()\n\n For i As Integer = 0 To inputbytes.Length - 1\n builder.Append(String.Format(\"{0,2:x}\", inputbytes(i)).Replace(\" \", \"0\"))\n Next\n\n Return builder.ToString().ToUpper()\nEnd Function\n\nPublic Shared Function Sha512(ByVal text As String) As String\n Dim provider = CodePagesEncodingProvider.Instance\n Encoding.RegisterProvider(provider)\n Dim cryptoServiceProvider = New SHA512CryptoServiceProvider()\n Dim inputbytes = cryptoServiceProvider.ComputeHash(Encoding.GetEncoding(\"ISO-8859-9\").GetBytes(text))\n Dim builder = New StringBuilder()\n\n For i As Integer = 0 To inputbytes.Length - 1\n builder.Append(String.Format(\"{0,2:x}\", inputbytes(i)).Replace(\" \", \"0\"))\n Next\n\n Return builder.ToString().ToUpper()\nEnd Function\n\nPublic Shared Function GetHashData(ByVal userPassword As String, ByVal terminalId As String, ByVal orderId As String, ByVal cardNumber As String, ByVal amount As ULong, ByVal currencyCode As Integer) As String\n Dim hashedPassword = Sha1(userPassword & \"0\" & terminalId)\n Return Sha512(orderId & terminalId & cardNumber & amount & currencyCode & hashedPassword).ToUpper()\nEnd Function
public static String calculateHash(String data, String algorithm, String charset) throws UnsupportedEncodingException, NoSuchAlgorithmException {\n\tMessageDigest md = MessageDigest.getInstance(algorithm);\n\tbyte[] databytes = data.getBytes(charset);\n\t\n\tmd.update(databytes);\n byte[] hashBytes = md.digest();\n \n return byteArray2HexaDecimal(hashBytes);\n}\n\npublic static String sha1(String data) throws UnsupportedEncodingException, NoSuchAlgorithmException { \n return calculateHash(data, \"SHA-1\", \"ISO-8859-9\").toUpperCase();\n}\n\npublic static String sha512(String data) throws UnsupportedEncodingException, NoSuchAlgorithmException { \n return calculateHash(data, \"SHA-512\", \"ISO-8859-9\").toUpperCase();\n}\n\npublic static String getHashData(String userPassword, String terminalId, String orderId, String cardNumber, Long amount, int currencyCode) {\n var hashedPassword = sha1(userPassword + \"0\" + terminalId);\n return sha512(orderId + terminalId + cardNumber + amount + currencyCode + hashedPassword);\n}
private function GenerateSecurityData($terminalId)\n {\n $password = \"password\";\n\n $data = [\n $password,\n str_pad((int)$terminalId, 9, 0, STR_PAD_LEFT)\n ];\n\n $shaData = sha1(implode('', $data));\n\n return strtoupper($shaData);\n }\n\n public function GenerateHashData()\n {\n $orderId = \"order_id\"; //must be uniqe\n $terminalId = \"terminal_id\"; //must be integer\n $cardNumber = \"1234123412341234\"; //card number\n $amount = \"100\"; //amount\n $currencyCode = \"currency_code\"; //must be int\n\n $hashedPassword = GenerateSecurityData($terminalId);\n\n $data = [\n $orderId, $terminalId, $cardNumber, $amount, $currencyCode, $hashedPassword\n ];\n \n $shaData = strtoupper(hash(\"sha512\", implode('', $data)));\n\n return strtoupper($shaData);\n }
Request Structure
The request structure required for Virtual POS Returns Non 3ds is specified in the table below. The information and explanations required for each tag under the main tag in the first column in the table should be examined and the request message should be provided according to the rules specified in this table:
<?xml version=\"1.0\" encoding=\"iso-8859-9\"?>\n<GVPSRequest>\n\t<Mode>TEST</Mode>\n\t<Version>512</Version>\n\t<Terminal>\n\t\t<ProvUserID>PROVRFN</ProvUserID>\n\t\t<HashData>F252824795D1128797922A61320819721E5D178BDF6401C09EF742DF5833A88559978CCC164B8161FD4424DBB77D80BAC470991A549E774A8F490C47EC717B38</HashData>\n\t\t<UserID>PROVAUT</UserID>\n\t\t<ID>30691297</ID>\n\t\t<MerchantID>7000679</MerchantID>\n\t</Terminal>\n\t<Customer>\n\t\t<IPAddress>192.168.0.1</IPAddress>\n\t\t<EmailAddress>eticaret@garanti.com.tr</EmailAddress>\n\t</Customer>\n\t<Order>\n\t\t<OrderID>ec2e065b7e32496a8986a18957a7e60e</OrderID>\n\t\t<GroupID />\n\t</Order>\n\t<Transaction>\n\t\t<Type>refund</Type>\n\t\t<Amount>10000</Amount>\n\t\t<CurrencyCode>949</CurrencyCode>\n\t\t<CardholderPresentCode>0</CardholderPresentCode>\n\t\t<MotoInd>H</MotoInd>\n\t</Transaction>\n</GVPSRequest>\n
Within this structure, many tags contain sub-tags within themselves. Under the relevant heading where each tag is described, the usage rules of tags without subtags and the details of tags with subtags are presented in a separate heading.
| Bottom Label | Max Size | Data Writing Format | Description and notes |
|---|---|---|---|
| <Mode> | PROD | This is the field where the process mode is written | |
| <Version> | 16 byte | No format requirement | This is the field where the Api version used is written. Within the scope of hash calculation as Sha512, 512 value must be sent in this field. |
| <Terminal> | This tag contains sub tags. The tags it contains and their rules are given in the following headings. | ||
| <Customer> | This tag contains sub tags. The tags it contains and their rules are given in the following headings. | ||
| <Order> | This tag contains sub tags. The tags it contains and their rules are given in the following headings. | ||
| <Transaction> | This tag contains sub tags. The tags it contains and their rules are given in the following headings. |
<Terminal> Tag and the Tag to be placed under it and its Details
Virtual such as virtual pos number user information to ensure pos verification parameters are sent.
<Terminal>\n\t<ProvUserID></ProvUserID>\n\t<HashData></HashData>\n\t<UserID></UserID>\n\t<ID></ID>\n\t<MerchantID></MerchantID>\n</Terminal>
The sub-tags within this tag and their details are given below:
| Bottom Label | Max Size | Data Writing Format | Description and notes |
|---|---|---|---|
| <ProvUserID> | 32 byte | No format requirement | This is the field where the provision user code of the terminal is sent. Prov user, Cancel refund user or OOS user can be found here |
| <HashData> | 32 byte | Hash algorithm SHA512 format. After hash conversion, lower case letters must be converted to upper case. Details are given below. | This is the field where the user's password verification is performed. Hash creation details are explained separately in this document. |
| <UserID> | No format requirement | This is the field where the user who made the transaction (Agent - Sales Representative) is sent. | |
| <ID> | 9 byte | Nümerik | The field where the terminal number is sent |
| <MerchatID> | 9 byte | Nümerik | This is the field where the workplace number is sent. |
<Customer> Tag and Rules for the <Customer> Tag and Tags Below it
This is the field where Customer Information is sent. It is mandatory to send the information in the tag.
<Customer>\n <IPAddress></IPAddress>\n <EmailAddress></EmailAddress>\n</Customer>
| Bottom Label | Max Size | Data Writing Format | Description and notes |
|---|---|---|---|
| <IPAdress> | 20 byte | No format requirement | This is the field where the IP address of the customer who made the transaction is sent. It must be sent compulsorily in order to ensure fraud controls. |
| <EmailAddress> | 64 byte | This is the field where the E-Mail address of the customer who made the transaction is sent. |
<Order> Label and Rules for the <Order> Label
This is the field where the information and details of the order are sent.
<Order>\n\t<OrderID></OrderID>\n\t<GroupID />\n</Order>
| Bottom Label | Max Size | Data Writing Format | Description and notes |
|---|---|---|---|
| <OrderID> | 36 byte | No format requirement | This is the field where the Order Number is sent. Order based must be unique. It must be generated by companies |
| <GroupID> | 36 byte | No format requirement | It is the field used to categorize (group) orders. For example: Orders sent with campaigns can be separated with an information written in GroupID. |
<Transaction> Tag and its Rules
This is the field where transaction information and financial information are sent.
<Transaction>\n\t<Type>sales</Type>\n\t<Amount>10000</Amount>\n\t<CurrencyCode>949</CurrencyCode>\n\t<CardholderPresentCode>0</CardholderPresentCode>\n\t<MotoInd>N</MotoInd>\n</Transaction>\n
| Bottom Label | Max Size | Data Writing Format | Description and notes |
|---|---|---|---|
| <Type> | 32 byte | Alphanumeric | This is the field where the Transaction Type is sent. Details about transaction types will be given separately in the document. Attention should be paid to the use of other fields according to the transaction type. |
| <Amount> | 17,2 number | The numeric is sent as LLLLLLKK. The last 2 digits represent cents. 1,00 TL -> 100 11,22 TL->1122 0,01TL -> 1 | This is the field where the amount information is entered. If the transaction is a "Partial Refund" transaction, the amount entered in this field is refunded. |
| <CurrencyCode> | 3 byte | Numeric | This is the field where exchange rate information is sent. 949 -> TL will be informed for other exchange rates according to your authorization. |
| <CardholderPresentCode> | 2 byte | Numeric | Enter 0 for normal transactions and 13 for 3D transactions. |
| <MotoInd> | 1 byte | Alphanumeric | It takes Y and N values. N is sent for Ecommerce transactions. Y is sent for transactions with Moto transaction status. |
Response Structure
For Virtual POS Returns Non 3ds, the response structure returned from the service after the request sent in the previous headings is specified in the table below. The information and explanations required for each tag under the main tag in the first column in the table should be examined and the request message should be provided according to the rules specified in this table:
In the Virtual POS Return transaction, the response structure is generally as follows:
<GVPSResponse>\n\t<Mode></Mode>\n\t<Terminal>\n\t\t<ProvUserID>PROVRFN</ProvUserID>\n\t\t<UserID>PROVAUT</UserID>\n\t\t<ID>30691297</ID>\n\t\t<MerchantID>7000679</MerchantID>\n\t</Terminal>\n\t<Customer>\n\t\t<IPAddress>192.168.0.1</IPAddress>\n\t\t<EmailAddress>eticaret@garanti.com.tr</EmailAddress>\n\t</Customer>\n\t<Order>\n\t\t<OrderID>981fb46e0d464dab9de9f392f090a892</OrderID>\n\t\t<GroupID></GroupID>\n\t</Order>\n\t<Transaction>\n\t\t<Response>\n\t\t\t<Source>HOST</Source>\n\t\t\t<Code>00</Code>\n\t\t\t<ReasonCode>00</ReasonCode>\n\t\t\t<Message>Approved</Message>\n\t\t\t<ErrorMsg></ErrorMsg>\n\t\t\t<SysErrMsg></SysErrMsg>\n\t\t</Response>\n\t\t<RetrefNum>210707283286</RetrefNum>\n\t\t<AuthCode>224386</AuthCode>\n\t\t<BatchNum>004568</BatchNum>\n\t\t<SequenceNum>005551</SequenceNum>\n\t\t<ProvDate>20220417 14:48:35</ProvDate>\n\t\t<CardNumberMasked>540669****1173</CardNumberMasked>\n\t\t<CardHolderName>4517*** 4517****</CardHolderName>\n\t\t<CardType>BONUS</CardType>\n\t\t<HashData>019749C176C4F40131A2AC67859676D7E327256676C7D5E09DEF353B9A725B65F2EE30CA4DC805098D5CB0D553FEAFF766A20FFF23F3253E74DD9585D7411CCC</HashData>\n\t\t<HostMsgList></HostMsgList>\n\t\t<RewardInqResult>\n\t\t\t<RewardList></RewardList>\n\t\t\t<ChequeList></ChequeList>\n\t\t</RewardInqResult>\n\t</Transaction>\n</GVPSResponse>\n
The tags in the answer structure given above and the sub tags under these tags are given in the heading below:
| Bottom Label | Data Writing Format | Description and notes |
|---|---|---|
| <Mode> | PROD - TEST | This is the field where the process mode is written |
| <Customer> | This is the field where the customer information sent in the request structure is sent back for verification purposes. | |
| <Order> | This tag contains sub tags within itself. The sub tags it contains are given in the headings below. | |
| <Transaction> | This tag contains sub tags within itself. The sub tags it contains are given in the headings below. |
<Order> Tag Label and Rules for the <Order> Tag
This is the field where the order information sent in the request is returned in the same way in the response.
<Order>\n <OrderID></OrderID>\n <GroupID></GroupID>\n</Order>
| Bottom Label | Data Writing Format | Description and notes |
|---|---|---|
| <OrderID> | Alfanümerik | This is the field where the order number is returned. |
| <GroupID> | Alfanümerik | The field where the GroupID number is returned. This tag contains sub tags. Details about the sub tags are given in the headings below. |
<Transaction> Tag Label and Rules of the <Transaction> Tag
<Transaction>\n <Response></Response>\n <RetrefNum></RetrefNum>\n <AuthCode></AuthCode>\n <BatchNum></BatchNum>\n <SequenceNum></SequenceNum>\n <ProvDate></ProvDate>\n <CardNumberMasked></CardNumberMasked>\n <CardHolderName></CardHolderName>\n <CardType></CardType>\n <HashData></HashData>\n <HostMsgList></HostMsgList>\n <RewardInqResult></RewardInqResult>\n <CampaignChooseLink></CampaignChooseLink>\n <GarantiCardInd></GarantiCardInd>\n</Transaction>
| Bottom Tags | Data Writing Format | Description and notes |
|---|---|---|
| <Response> | This tag contains sub tags. Details about the sub-tags are given in the headings below. | |
| <RetrefNum> | Nümerik | The transaction number generated by Virtualpos is returned |
| <AuthCode> | Nümerik | This is the field where the confirmation code is returned. |
| <BatchNum> | This is the field that returns which batche the transactions will enter. | |
| <SequenceNum> | This is the field where the name of the cardholder is sent. | |
| <ProvDate> | YYYYMMDD | This is the field where the provision date is returned. |
| <CardNumberMasked> | This is the field where the first 6 and last 4 digits of the card number and the fields in between are returned with *. | |
| <CardHolderName> | This is the field where the name of the cardholder is sent. | |
| <CardType> | This is the field where the type of card processed is returned. | |
| <HashData> | This is the field where the HashData information of the transaction is returned. | |
| <HostMsgList> | This tag contains sub tags. Details about the sub-tags are given in the headings below. | |
| <RewardInqResult> | This tag contains sub tags. Details about the sub-tags are given in the headings below. | |
| <GarantiCardInd> | ||
| <CampaignChooseLink> |
<Response> Subtags and Descriptions
| Bottom Tags | Description and notes |
|---|---|
| <Source> | This is the field where the source information is returned. |
| <Code> | This is the field where Approved - declined information is returned. |
| <ReasonCode> | The field where the response code is returned. |
| <Message> | Field where message information is returned. |
| <ErrorMsg> | The field where the error message is returned. |
| <SysErrMsg> | This is the field where the system error message is returned. |
<HostMsgList> Tag, Subtags and Descriptions
| Bottom Label | Data Writing Format | Description and notes |
|---|---|---|
| <HostMsg> | This is the field where campaign messages are returned. |
<RewardInqResult> Tag, Subtags and Descriptions
| Bottom Tags | Data Writing Format | Description and notes |
|---|---|---|
| <RewardList> | This tag contains sub tags. Details about the sub-tags are given in the headings below. | |
| <ChequeList> | This tag contains sub tags. Details about the sub-tags are given in the headings below. |
<RewardList> Tag and Descriptions
| Bottom Tags | Data Writing Format | Description and notes |
|---|---|---|
| <Reward> | This tag contains sub tags. Details about the sub-tags are given in the headings below. |
<ChequeList> Tag and Explanations
| Bottom Tags | Data Writing Format | Description and notes |
|---|---|---|
| <Cheque> | This tag contains sub tags. Details about the sub-tags are given in the headings below. |
Code Examples
Below are github repo links to virtual POS Advance Sales transaction examples written in different software languages. You can review the codes written with predefined values via the link of your preferred programming language.
- C# For Code Examples click here.
- VB.Net For Code Examples click here.
- For Java Code Examples click here.
- For PHP Code Examples click here.
Code Examples
Below are the github repo links for custom code examples written in different programming languages, including this transaction type. You can examine the codes written with predefined values through the link of your preferred programming language.
- C# For Code Examples click here.
- VB.Net For Code Examples click here.
- For Java Code Examples click here.
- For PHP Code Examples click here.
Error Codes
Error codes from this page you can reach.
Test Cards
List of test cards from this page you can reach.
