GP webpay System Administration
Role: MerchantAdmin
T
ABLE OF CONTENTS
:
INTRODUCTION ... 3
LOGING IN TO GP WEBPAY ... 3
MAIN MENU FOR THE MERCHANTADMIN ROLE ... 4
ADMINISTRATION ... 6 Change password ... 6 Contact info ... 6 PROCESS ORDERS ... 8 Search order ... 8 Deposit orders... 14 Search batches ... 15
Deleting unsettled orders ... 20
LOGOUT ... 21 ERROR STATUSES... 22 ANNEXES ... 24 Order status ... 24 Supported requests ... 25 Return codes... 27
© Global Payments Europe, s.r.o.
1. I
NTRODUCTION
This document is designed for merchants, who will accept payments in their e-shops carried out by payment cards issued by VISA, MasterCard and Diners Club associations using the Internet-based payment gateway GP webpay.
GP webpay supports fully the 3-D Secure standard and provides merchants with the possibility to integrate the functionality of a standard web interface by means of Web Services (WS).
The application can be accessed via URL address: https://3dsecure.gpwebpay.com/gui
Note: All screenshots used in the following text were copied from the GPE, s.r.o, testing environment and therefore their content does not have to fully correspond with the content of screens in real operation of the application.
2. L
OGING IN TO
GP
WEBPAY
After opening of the URL address, a screen for loging in the GP webpay application is displayed automatically. Access is permitted only after the username and password is entered.
Based on the data entered, the application makes the concrete user environment accessible.
The merchant receives a password for the first login to the system from the GP webpay system administrator in GPE together with the signed contract.
After successful login with this password, the GP webpay displays automatically a screen for the password change. The merchant enters there his/her new password, which will be used for his/her loging into the system in the future. It is in his/her own interest to use a password that is as “complicated” as possible, to make it uneasy for unauthorized persons to deduce it.
The password should never be a simple repeating of the merchant´s username. Whole words, or sequences of keys located next to each other on the keyboard, or sequences of numbers going one after another, etc., are not suitable for this purpose as well.
This manual describes all the possibilities that are offered by the application for the role defined on the side of the application user for the role of MerchantAdmin.
The main task of a user in the MerchantAdmin role (i.e. merchant´s administrator) is to process orders, i.e. to search for orders in accordance with the given conditions, to pay for orders, to search for batches, to close batches, or to delete incomplete orders.
3. M
AIN MENU FOR THE
M
ERCHANT
A
DMIN
ROLE
After the user is loged successfully into the system, the introductory screen with the main menu of the GP webpay application is displayed.
In heading of this screen – as well as of all the other screens – besides the application logo, there is displayed the title of the society and username of the loged user.
Content of the menu (i.e. concrete user environment of the application) corresponds with the role assigned to the loged user.
A language for further communication with the system can be selected by click on a relevant flag in the right corner of the screen heading.
Pic. 1: Successful login, MerchantAdmin role
Menu designed for a user with the MerchantAdmin role:
Administration:
▪ Change password of the loged user;
▪ Contact info – display of detailed information about the company and the list of registered merchants of the company;
▪ Search order – a possibility to find orders on the basis of identification of a merchant or an order, according to order status, date of payment, or currency and amount. Display of a summary of the orders found, possibility to display a detail of the selected order, including offer of possible (allowed) transactions;
▪ Deposit orders – display of all as yet unpaid orders (successfully authorized), a possibility to display a detail of a selected order, including offer of possible transactions. Deposit of the selected order, or of a group of orders;
▪ Search batches – a possibility to find merchant´s batches on the basis of the batch´s identification, according to the batch´s status, opening or closing date of the batch. Display of summary of the searched out orders with a possibility to display selected batches. Display of summary of orders included in the batch, a possibility to display a detail of the order with an offer of other possible transactions. A possibility to close the opened batch;
▪ Deleting unsettled orders – display of the summary of uncompleted orders, a possibility to display detailed data of the selected order. Deletion of selected orders (individual, or all of them).
Logout
4. A
DMINISTRATION
Change password
Clicking on Change password in the “Administration” menu opens the Change password
screen. After entering the old and new password, confirmation of the new password is requested.
Following the data sending, if the password change has been successful, information about the carried out change is displayed. The user is invited to change the password automatically after the first login.
The choice “Change password” is a part of the menu designed for a user loged into the application by a name and a password.
The period of validity of the password is set by the system administrator in GPE, s.r.o.
Contact info
After clicking on Contact info from the “Administration” menu, a Company info screen with detailed information about the company, including the list of all the registered merchants of this company.
Pic. 2: Information about the company
Coloured points in the Merchant number column distinguish authorized and unauthorized merchants.
There is accessible the customer support e-mail on the screen; contact the customer support if the data displayed does not correspond to reality.
The most important data:
- Certificate validity – Valid From/Valid Until – cipher algorithms taking into account the key validity
- Certificate fingerprint – usually entered in the contract with a bank Tip for implementation
Data from certificate fingerprint is possible to compare with your currently used private key to find out if the relevant certificate is entered into the system. Numerous misunderstandings can be prevented this way in the course of implementation of cipher procedure.
5. P
ROCESS ORDERS
Search order
After loging to the GP webpay application, the Search order screen is displayed automatically, i.e. the default choice Search order from the “Process order” menu.
Pic. 3: Searching for orders - Filter
Options of the setting of the Merchant filter
▪
Merchant:
the merchant´s name, the local offer is available;
▪
Merchant Nr.
: the merchant´s number in the GP webpay application. Local offer is
available. The second field, into which the merchant´s complete number has to be
entered, is designed for a quick search for a particular merchant;
▪
Order
: the order number in the GP webpay application;
▪
Order merchant
: the order number
1in the merchant´s system.
State
▪
In the tick field, there is marked the order status, see Annex:
Order status
.
1
The order number is indicated on the statement of transactions that have been made by the payment cards (the statement is designed both for the card holders and the merchants).
Date of payment
▪
Range - last
: after marking of this choice, the number of units is entered (minutes,
hours, days, months), chosen from the local offer;
▪
After
: there is entered the number of hours (from the local offer), or the date of
payment (from the calendar);
▪
Before
: there is entered the number of hours (from the local offer), or the date of
payment (from the calendar);
Ordered
▪
Currency
: the currency of the order is selected from the local offer;
▪
Bigger than
: the amount of the order is bigger than the value entered;
▪
Smaller than
: the amount of the order is smaller than the value entered;
Ticked/filled-in criteria are confirmed by pressing the Submit button.
After pressing the Clear button, all the up to now recorded selection criteria will be deleted from the form, which is valid also for all other forms, where the above-mentioned buttons are also placed.
After possible sending of an empty form, all orders of the selected merchant will be searched out, except from the orders in the DELETE status.
Search result - order
In the summary of orders searched out according to conditions specified in the previous step, there is displayed basic information about the found orders.
In the upper part of the screen, there is positioned a bar with links distinguished by colours. These links are designed for a quick return to one of the previous screens (it is valid also for all the other screens).
Information about the result of searching contains the number of found and displayed entries. If Open order in new window field is ticked, then after clicking on the requested order, detailed information will be displayed in a new window/tab.
The second column of the order summary (untitled) indicates the type of a transaction. If it is empty (undistinguished), the standard payment has passed.
If the merchant is authorized for repeated payments, there can be value “R” or “R N”.
R refers to a payment – repeated master. In case that this payment has been followed by a repeated payment, the detailed data of the payment will contain also reference to these repeated payments (tabs Basic information and Sequence orders).
R N refers to a payment – repeated sequence. Detailed data of this payment displayed on the
Basic information tab contains reference to the repeated master (the field – Original order).
GP webpay displays maximally 100 items per page in response to 1 request; it means that if the number of selected orders is higher, not all of the orders are displayed. Therefore it is recommended to input an as precise as possible request to search for a concrete order.
Arrangement of orders in the summary can be changed; after clicking on a title of any column, the summary will be sequenced according to the content of this column.
In the summary of authorized orders, the merchant selects individual orders for further processing.
The Select all button can be used for marking of all orders at the same time.
All the originally not ticked orders will be marked after clicking on the Invert selection button. The Clear button cancels the selection made up to now; marking of all ticked fields will be cleared away at the same time.
The button with an arrow (forward, back) displays the following (preceding) page of the summary.
Process order
A prerequisite for processing of the marked orders is setting of the corresponding Keystore and input of Password for access into this keystore2. This is a standard way of confirmation of all requests for processing in GP webpay.
Sending of a request has to be confirmed once more. In case of multiple orders it can be e.g. the Deposit selected button, or the Delete selected button.
If detailed data of a selected order is displayed, then there is the Process button available (this button carries out an operation selected from Potential transaction).
Pic. 5: Search result - order – Entering of Keystore and password
2
Password and Keystore generates the merchant by himself/herself at the moment of signing the contract with GPE, s.r.o..
Detail of an order
Detailed data of the selected order will be displayed after clicking on an item in the summary of the searched-out orders:
Pic. 6: Detail of an order
Besides basic information about the order, the GP webpay offers also the option Potential transaction. Further possible processing depends on the current status of the order.
An authorized order (Pic. 4) can be paid (DEPOSIT) or the order authorization can be invalidated (APROVE_REVERSAL).
A detailed description of the order status, see Annex: Order status.
Description of supported requests (possible transactions), see Annex: Chyba! Nenalezen zdroj odkazů..
If a user marks one of the allowed transactions, GP webpay may offer in some cases another field for filling-in of necessary data.
For example as concerns the CREDIT or DEPOSIT requests, Amount of credit (deposit) has to be specified as well, if CREDIT_REVERSAL is requested, the number of credit (Number) has to be added.
The Process request for an individual order is confirmed in the usual fashion (entering of Keystore path and of password).The user is informed about the result of processing.
Information about the result of the order processing.
Pic. 7: Information about the successful order processing
In the report about the successful order processing, there are the primary (PRCODE) and the secondary (SRCCODE) return codes set to “0” value; the text designed for the error description contains “OK” value, the OK-column contains a green point.”
In the report about the unsuccessful order processing, the PRCODE return code contains the type of error, while SRC contains specification of this error. The text describes the type of error and the OK-column contains a red point.
Pic. 8: Information about unsuccessful processing of an order
Deposit orders
The summary of successfully authorized orders is displayed after selection of Deposit orders from the “Process orders” menu. These orders are in the status “authorized” - APPROVED and they are ready for deposit.
Pic. 9: The searched-out orders designated for deposit
Detailed information about the selected order will be displayed after clicking on an item in the summary of orders; it means that before the transaction is authorized, some data may still be verified.
Orders for processing can be selected one by one (by ticking) or they can be marked altogether (the Select all button), or there can be used the button to Invert selection. After the request is confirmed, the marked orders will be processed.
The result of a successfully processed (i.e. deposited) order is a request for entering the order into accounts. This request is transmitted to the card issuer.
The carried-out deposit can be invalidated.
The request for invalidation of the deposit can be used only for deposited orders, which have not been processed yet, i.e. the batch containing this order has not been closed.
Search batches
After selecting Search batchesfrom the “Process order” menu, the Search batch screen with a relevant form – filter is displayed.
Pic. 10: Searching for batches - filter
Options of the filter setting - Merchant
▪
Merchant:
the merchant´s name. The local offer is available;
▪
Merchant Nr
.: the merchant´s number in the GP webpay application. The local offer
is available;
▪
Batch
: the number of batch;
State
▪
the requested batch status (closed, opened) is marked in the tick fields;
Date of opening batch
▪
After
: the batch was opened after the given date (the calendar for selection and
transmission of the date is available);
▪
Before
: the batch was opened before the given date (calendar);
Date of closing batch
▪
After
: the batch was closed after the given date (the calendar for selection and
transmission of the date is available);
Search result of batches
Information about the result of searching contains the number of searched-out and displayed items.
In the summary of the searched-out batches, there is displayed a number and status of the batch, time of opening and closing of the batch.
Pic. 11: Summary of the searched-out batches
Detail of a batch
After clicking on the selected item, there will be displayed basic information about the batch together with the summary of all payments (a Payments tab) and credits (a Credits tab) contained in this batch. The opened batch can be closed.
After clicking on the selected item on the Payments tab or the Credits tab, detailed information about the order including the offer of other possible transactions will be displayed.
Pic. 14: Detail of an order (with credits)
The offer of Possible transactions depends on the status of the order and the batch (closed/unclosed), in which this order is contained.
Everything goes in the usual fashion after selection (marking) of the authorized transaction, i.e. possible entry of the requested data, Keystore verification, a password entry and a request confirmation.
The user will be informed about the result of transaction in the usual fashion as well.
Deleting unsettled orders
After selecting Deleting unsettled orders from the “Process order” menu, the summary of all orders in the REQUESTED status is displayed.
Pic. 15: Requested orders
Orders to be processed (delete) can be selected one by one (by ticking) or they can be marked altogether (the Select all button), or there can be used the button for Invert selection.
After the request is confirmed in a standard way, the marked requested orders will be deleted. Information about the result of processing is displayed, e.g.:
Details of a deleted order
If the Transaction result screen will contain the summary of deleted orders, then after clicking on a selected item, the following basic information will be displayed:
Pic. 17: Details of a deleted order
6. L
OGOUT
To log out from the application is designed the Logout option.
After clicking on this offer, the following information is displayed “
You have been logged off
from the GP Webpay application. For security reasons, please, close the window of your
browser.
“7. E
RROR
S
TATUSES
The application distinguishes between two types of messages – information and error messages. Both types of messages are displayed above the form, to which they are referring. The Information message (a blue form) usually informs about the result of the just completed action.
Pic. 18: Information about an unsuccessful searching
The Error message (a red form) notifies of serious errors that have to be corrected, otherwise processing cannot continue.
8. A
NNEXES
Order status
Status Status description Possible
following statuses
REQUESTED The order has been successfully received by GP webpay. The system now waits for the result of sensitive data filled in (entered) by the cardholder.
After the card holder enters sensitive data, the request is sent to the 3D system to find out if authentication of the card holder is required. The system waits for the result from the 3D system.
If the cardholder stops entering the card data, this will be the final status of the order.
CANCELED The cardholder canceled the payment (the cardholder
chose the option "Back to e-shop" on the payment page)
APPROVED The result of the authentication of the card holder in 3D has been successful, a request for authorization is sent to the authorization centre.
The result of the authorization is successful.
DEPOSITED REVERSED REVERSED The authorization of the order is invalidated.
The money previously authorized has been unblocked.
DELETED UNAPPROVED The result of the authorization of the order is not
successful. The order cannot be paid for. The system cannot continue.
DELETED
DEPOSITED The order has been marked for payment during the following batch processing.
The payment can be invalidated before the batch containing the payment is closed.
PROCCESED APPROVED
PROCESSED The batch has been automatically closed and the data has been transmitted to the financial systems.
CREDITED CLOSED CLOSED The order has been closed. The only allowed operation
now is deletion.
DELETED DELETED The order has been deleted.
CREDITED The order has been marked for return during the following batch processing.
A return of the order can be invalidated any time before the batch containing the order is closed. The order remains in this status after the batch is closed.
More than one credit can be created for an order.
CLOSED
DECLINED The result of the authentication of the card holder in the 3D system has not been successful.
The card holder has not been authenticated. The system cannot continue. The order can be deleted.
Supported requests
Supported requests for orders
Request Meaning Description Possible
previous statuses Possible final statuses approveReversal Invalidation of the order authorization
Request to make the authorization of an order invalid. Applicable only to successfully authorized orders. APPROVED REVERSED deposit Payment of an
order Request to pay (to account for) an order. It is used to
mark an order for further processing after which a request for the accounting for of the financial transaction is sent to the acquirer bank.
The accounting for of the transaction is the responsibility of the acquirer bank. Applicable only to successfully authorized orders. APPROVED DEPOSITED depositReversal Making a payment for the order invalid
Request to make the payment of an order invalid.
Applicable only to paid orders that have not yet been processed. The money will not be transferred from the card holder to the merchant.
DEPOSITED APPROVED
credit Return of an
order Request to return the payment for orders that
have already been processed.
It is used to mark an order for further processing after which the money will be transferred back from the merchant to the card holder.
PROCESSED CREDITED
Request Meaning Description Possible previous statuses
Possible final statuses
creditReversal Making the return of an order invalid
Request to cancel the reversal of the payment for an order.
Applicable only to orders made invalid that have not yet been processed - the money will not be transferred back from the merchant to the
cardholder.
CREDITED The batch containing the credit must still be opened
DEPOSITED (if there are no other valid credits) CREDITED
closeOrder Closing of an order
Request to close an order DEPOSITED PROCESSED CREDITED
CLOSED
delete Deleting of an order
Request to delete an order DECLINED UNAPPROVED REVERSED CLOSED
DELETED
Supported requests for batches
Request Meaning Description Possible
previous statuses Possible final statuses batchClose Closing of a batch of orders
Request to close a batch containing orders marked for further processing.
This request does not necessarily need to be sent. Batches are closed
automatically before they are processed.
Return codes
PRCODE - PrimaryReturnCode
PRCODE / primaryReturnCode
Value Meaning in Czech Meaning in English
0 OK OK
1 Pole příliš dlouhé Field too long
2 Pole příliš krátké Field too short
3 Chybný obsah pole Incorrect content of field
4 Pole je prázdné Field is null
5 Chybí povinné pole Missing required field
11 Neznámý obchodník Unknown merchant
14 Duplikátní číslo objednávky Duplicate order number
15 Objekt nenalezen Object not found
17 Částka k úhradě překročila autorizovanou
částku Amount to deposit exceeds approved amount
18 Součet kreditovaných částek překročil uhrazenou částku
Total sum of credited amounts exceeded deposited amount
20 Objekt není ve stavu odpovídajícím této
operaci
Object not in valid state for operation
26 Technický problém při spojení s
autorizačním centrem Technical problem in connection to authorization centre
27 Chybný typ objednávky Incorrect order type
28 Zamítnuto v 3D
Důvod zamítnutí udává SRCODE Declined in 3D
30 Zamítnuto v autorizačním centru Důvod zamítnutí udává SRCODE
Declined in AC
31 Chybný podpis Wrong digest
35 Vypršel čas pro zadání čísla karty. Objednávku nelze dokončit
Session expired. Order is not valid
50 Držitel karty zrušil platbu The cardholder canceled the payment
SRCODE – SecondaryReturnCode
SRCODE / secondaryReturnCode
Value Meaning in Czech Meaning in English
0 Bez významu No meaning
If PRCODE is 1 to 5, 15 and 20, the following SRCODE may return
1 ORDERNUMBER ORDERNUMBER 2 MERCHANTNUMBER MERCHANTNUMBER 5 CVC/CVV CVC/CVV 6 AMOUNT AMOUNT 7 CURRENCY CURRENCY 8 DEPOSITFLAG DEPOSITFLAG 10 MERORDERNUM MERORDERNUM 11 CREDITNUMBER CREDITNUMBER 12 OPERATION OPERATION 18 BATCH BATCH 22 ORDER ORDER 24 URL URL 25 MD MD 26 DESC DESC 34 DIGEST DIGEST
If PRCODE is 28, the following SRCODE may return 3000 Zamítnuto v 3D. Neúspěšné ověření držitele
karty.
Info: Ověření držitele karty bylo neúspěšné (neplatně zadané údaje, stornování
autentikace, uzavření okna pro autentikaci držitele karty se zpětnou vazbou…). V transakci se nesmí pokračovat.
Declined in 3D. Cardholder not authenticated in 3D.
Note: Card holder authentication failed (wrong password, transaction cancelled, authentication window was closed…).
Transaction Declined.
3001 Držitel karty ověřen.
Info: Ověření držitele karty v 3D systémech proběhlo úspěšně. Pokračuje se autorizací objednávky.
Authenticated
Note: Card holder was successfully authenticated – transaction continue with authorization.
3002 Neověřeno v 3D. Vydavatel karty nebo karta
není zapojena do 3D
Info: V 3D systémech nebylo možné ověřit držitele karty – karta, nebo její vydavatel, není zapojen do 3D.
V transakci se pokračuje.
Not Authenticated in 3D. Issuer or Card holder not participating in 3D Note: Card holder wasn’t
authenticated – Issuer or Card holder not participating in 3D. Transaction can continue.
Value Meaning in Czech Meaning in English
3004 Neověřeno v 3D. Vydavatel karty není
zapojen do 3D nebo karta nebyla aktivována.
Info: V 3D systémech nebylo možné ověřit držitele karty – karta není aktivována, nebo její vydavatel, není zapojen do 3D.
V transakci je možné pokračovat.
Not authenticated in 3D. Issuer not participating or card holder not enrolled.
Note: Card holder wasn’t authenticated – Card holder not enrolled or Issuer or not participating in 3D.
Transaction can continue.
3005 Zamítnuto v 3D.Technický problém při ověření držitele karty
Info: V 3D systémech nebylo možné ověřit držitele karty – vydavatel karty nepodporuje 3D, nebo technický problém v komunikaci s 3D systémy finančních asociací, či
vydavatele karty.
V transakci není možné pokračovat,
povoleno z důvodu zabezpečení obchodníka před případnou reklamací transakce
držitelem karty.
Declined in 3D. Technical problem during card holder authentication.
Note: Card holder authentication unavailable – issuer not supporting 3D or technical problem in
communication between
associations and Issuer 3D systems. Transaction cannot continue.
3006 Zamítnuto v 3D. Technický problém při
ověření držitele karty.
Info: V 3D systémech nebylo možné ověřit držitele karty – technický problém ověření obchodníka v 3D systémech, anebo v komunikaci s 3D systémy finančních asociací, či vydavatele karty.
V transakci není možné pokračovat.
Declined in 3D. Technical problem during card holder authentication.
Note: Technical problem during card holder authentication – merchant authentication failed or technical problem in communication between association and acquirer. Transaction cannot continue.
3007 Zamítnuto v 3D. Technický problém v systému zúčtující banky. Kontaktujte obchodníka.
Info: V 3D systémech nebylo možné ověřit držitele karty – technický problém v 3D systémech.
V transakci není možné pokračovat.
Declined in 3D. Acquirer technical problem. Contact the merchant.
Note: Technical problem during card holder authentication – 3D systems technical problem. Transaction cannot continue.
3008 Zamítnuto v 3D. Použit nepodporovaný karetní produkt.
Info: Byla použita karta, která není v 3D systémech podporována.
V transakci není možné pokračovat.
Declined in 3D. Unsupported card product.
Note: Card not supported in 3D. Transaction cannot continue.
If PRCODE is 30, the following SRCODE may return
1001 Zamitnuto v autorizacnim centru, karta blokovana3
Zahrnuje důvody, které naznačují zneužití platební karty – kradená karta, podezření na podvod, ztracená karta a pod.
Většinou pokus o podvodnou transakci.
Declined in AC, Card blocked
Includes the reasons implying that the card has been misused – a stolen card, suspected card fraud, a lost card, etc.
1002 Zamitnuto v autorizacnim centru, autorizace zamítnuta
Z autorizace se vrátil důvod zamítnutí “Do not honor“.
Vydavatel, nebo finanční asociace zamítla autorizaci BEZ udání důvodu.
Declined in AC, Declined
Reason:
Card issuer or financial association rejected authorization (“Don Not Honor”)
1003 Zamitnuto v autorizacnim centru, problem karty
Zahrnuje důvody:
expirovaná karta, chybné číslo karty, nastavení karty - pro kartu není povoleno použití na internetu, nepovolená karta, expirovaná karta, neplatná karta, neplatné číslo karty, částka přesahuje maximální limit karty, neplatné CVC/CVV, neplatná délka čísla karty, neplatná expirační doba, pro kartu je požadována kontrola PIN.
Declined in AC, Card problem
Possible reasons:
Expired card, wrong card number, Internet transaction not permitted to Card holder, invalid card, invalid card number, amount over card maximum limit, wrong CVC/CVV, invalid card number length, invalid expiry date, PIN control is required for the card used.
1004 Zamitnuto v autorizacnim centru, technicky problem
Autorizaci není možné provést z technických důvodů – technické problémy v systému vydavatele karty, nebo finančních asociací a finančních procesorů.
Declined in AC, Technical
problem in authorization process
Authorization rejected – technical problem.
Technical problem in card issuer systems or financial associations systems (Card issuer unavailable)
1005 Zamitnuto v autorizacnim centru, Problem uctu
Důvody: nedostatek prostředků na účtu, překročeny limity, překročen max. povolený počet použití…
Declined in AC, Account problem
Possible reasons: finance absence, over account limit, over daily limit, etc.
3
Only bolded part of this and the below mentioned cells of this column will be contained in the RESULTTEXT field (optional field) in the response sent to the merchant. The remaining text is given only for explanatory purposes.
