Ukrcard en
    Ukrcard en
    • Overview
    • Integration
    • Recipes
    • General Concepts
    • Merchant dashboard
    • References
      • Transaction processing flows
      • Response Codes
      • Test Data
    • Our Restful API
      • E-Commerce acquiring
        • /Payment
        • /Preauthorization
        • /CancelPreauthorization
        • /Completion
        • /Confirm
        • /ConfirmExt
        • /Reverse
        • /Refund
        • /Verify
      • Transfers
        • /р2рTransfer
        • /Confirm
        • /ConfirmExt
        • /Reverse
        • /Refund
        • /Verify
      • Cards and accounts (UAPI)
        • cards/{PanID}
        • 3. PUT changeCardLimit-baseparam/limits/
      • Payment transactions using tokens
        • /Payment
        • /Preauthorization
        • /Confirm
        • /ConfirmExt
        • /р2рTransfer
        • /Panbytoken
      • Apple Pay
        • /PaymentAppleD
        • /PaymentAppleE
      • Google Pay
        • /PaymentGoogleD
        • /PaymentGoogleE

    Merchant dashboard

    Подивится українською
    The merchant dashboard is a user interface that allows you to access information about all the critical processes happening within your merchant account, as well as provide you with important metrics and performance indicators for your business.

    Entrance#

    To enter the personal account, you need to enter the login and password previously provided by the manager.
    image.png

    Operations monitoring#

    The main menu is used to navigate between cabinet pages.
    To start working with a certain functionality of the system, click on the corresponding menu and, if necessary, select the required item from the list of available functions.
    image.png
    LinkDescription
    1Provides a menu through which users can go to the functionality they need
    2Displays the username and provides the following buttons:
    - Reports - displays reports created by the user.
    - User - displays the user's login.
    - Settings - allows the user to change the interface language and user password.
    - Logout - allows the user to log out of the system.
    3Displays the menu that the user has selected
    4Allows the user to specify search criteria and perform entity searches controlled from the select menu
    5Displays search results. Some command buttons and other controls can be found below this list, helping the user control the displayed elements and appearance of the panel.
    6Exports search results on the Orders and Refunds pages to XLSX or CSV formats

    Order status#

    image.png
    The possible order statuses are listed below in the table:
    Status nameВнутрішня назваОпис
    CREATEDhas been startedThe order has been created
    APPROVEDpayment approvedThe amount of the order was successfully authorized by the issuer
    DECLINEDpayment declinedAuthorization or pre-authorization was rejected by the issuer
    REVERSEDpayment cancelledThe order was cancelled
    DEPOSITEDthe order is paidThe payment was successfully made by pre-authorization
    REFUNDEDreturnThe amount of the order was returned
    CREATED
    Order status is created if the customer has performed the following actions:
    Opened the payment page and closed it.
    Opened the payment page and tried to pay; the attempt failed, but not all attempts were used.
    From the "Created" state, the order can move to the "Approved" or "Rejected" state (if all available payment attempts have failed).
    APPROVED
    The status of the order is "Approved" if the order was successfully authorized.
    The payment can be canceled ("Cancellation") or "Completed".
    DECLINED
    The status of the order is "Rejected" if the following criteria are met:
    All available payment attempts have failed (authorization failed);
    Fraud was detected during any payment attempt;
    The client did not pass/failed 3DS authentication at the level of the issuing bank;
    The payment page was opened, but there were no payment attempts and the session ended;
    The payment page was opened and not all payment attempts were used, but the session ended
    DEPOSITED
    The status of the order is "Completed" if the payment is successfully completed.
    "Completed" is only active for two-phase payments and is used to manually change the status of an order from "Approved" to "Completed". It is possible to complete the payment for the entire amount of the pre-authorization or for a smaller amount, as well as for an amount greater than the pre-authorization but not more than 15% (set by the bank-acquirer).
    Completion of the two-phase payment must be done with "Done". There are two possible ways to complete:
    Automatic (requests using REST interface or web service interface);
    Clicking the "Finish" button on the order information page.
    If you click the Done button, a window will appear asking you to enter the completion amount. Payment can be made in full or in part. If no completion amount is specified, the full amount of the transaction is deposited.
    REVERSED
    "Cancel" payment is available for orders in "Approved" status.
    There are two ways to cancel:
    Automatically (requests using REST interface or web service interface);
    Clicking the "Cancel" button on the order details page.
    "Cancellation" can be made before the completion of the payment, but no later than the period specified in the contract with the bank. Cancellation unlocks the customer's card amount.
    "Cancellation" can be done only once. If this transaction fails (in other words, the request went through the processing system and ended in error), the next attempt will fail.
    Depending on the type of payment, cancellation can be made as follows:
    For single-phase payment, cancellation is available for orders in "Completed" status (the order status changes from "Completed" to "Cancellation").
    For two-phase payment, cancellation is available for orders in "Approved" status (the order status changes from "Approved" to "Cancellation")
    REFUND
    A partial or full refund is made in the event of the customer's refusal to receive the product or service or in the event of a return.
    Refunds can be made after the money has been credited to the client's bank account. The refund amount can be equal to or less than the closing amount.
    Refunds can be applied to "Completed" or "Return" orders.
    The "Refund" operation is available multiple times until the total amount of all refunds equals the "Completion" amount.
    The Returns page allows you to work with refunds. The page consists of a filter panel on the left side of the page and a table with a list of refunds.
    There are two ways to get a refund:
    Automatic (requests using REST interface or web service interface);
    By clicking the "Refund" button on the order information page

    Order details#

    To search for operations, you can use the "Order parameters" block in which you can configure filters
    image.png
    To view the transaction in detail, click on the Order number. Information on the details of the operation will open in a new tab.
    image.png

    Order history#

    To view the complete payment history, click on the "History" menu item on an open order, highlighted in red on the screen. Information about the payment history will open in a new tab.
    image.png
    An example of a history of successful operation
    image.png
    An example of a history of an unsuccessful operation
    image.png
    In addition to the current status of the order, the status of the order during the execution of the transaction can be tracked in the history.
    EventDescription
    Order registeredOrder registered in the system
    Authorization startedAuthorization has been started
    Authorization finishedAuthorization has been completed
    Deposit startedDeposit has been started
    Deposit finishedDeposit has been completed
    Reversal startedReversal has been started
    Reversal finishedReversal has been completed
    Refund startedRefund has been started
    Refund finishedRefund has been completed
    Refund failedThe return request caused an error (the order amount was not entered or there was a technical reason)
    Redirected to ACSA redirect to an ACS server has been sent to the client's web browser
    Returned from ACSThe customer was redirected from ACS to the payment results page
    Redirect to merchantA redirect to the merchant's site was sent to the customer's web browser
    Payment attemptedProcessing of payment parameters sent by the client has started
    Payment page loadedThe payment page has been loaded for the customer
    Fraud checkedFraud was detected during order verification
    Marked possible fraudThe transaction is marked as likely fraudulent
    Failed 3D SecureFailed to verify 3DS registration card. The card was not found in the list of 3-D Secure SecureCode cards or there was no connection to the ACS of the issuing bank
    SSL operation not allowedConducting a transaction using only SSL (without 3DS) is prohibited
    Session timeout occurredThe payment session has ended

    Cancel and return operations#

    According to the rules of payment systems, "Reversals" can be performed on the same day when the original operation was performed. Otherwise, it is necessary to perform the "Return" (refund) operation.
    In order to cancel the operation, you need to press the corresponding button (1) and confirm the corresponding command (2).
    image.png
    In order to perform the "Return" operation, you need to click the corresponding button (1), a new window will open in which you need to confirm the return amount (2) (it can be equal to or less than the authorization amount) and click "Confirm" (3)
    image.png

    Data export#

    Reports on filtered products (orders or refunds) can be exported to files in XLSX or CSV formats. The file containing the exported data contains the same columns as the checkout or refund table in the administration portal.
    You can choose which columns to display in the table with filtered items, and therefore the columns included in the report. To select the columns to display, click the arrow next to any parameter name, point to the Columns menu item, and check the boxes next to the desired column names
    image.png
    To export filtered data:
    1.
    In the appropriate menu (Order or Refund), find the companies you need using the appropriate filters (if you change the order of the columns).
    2.
    Click Export to Excel or Export to CSV. The report is added to the queue.
    3.
    When the queue is processed, click Reports (x) in the upper right corner of the panel. A dialog box displays a list of reports.
    4.
    In the dialog box, click Download the appropriate report. The dialog box contains options for opening the file in Microsoft Excel or saving it.
    5.
    Select the required option and click OK
    image.png
    Previous
    General Concepts
    Next
    Transaction processing flows
    Built with