Hizli QR

Overview

Hizli QR is a payment methods that allows to process payments by using Turkish banks online banking. Purchases can be processed by using Payment Page and Gate.

General information

Payment method type Online banking
Countries and regions Turkey
Payment currencies TRY
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
  • The purchase amount must be a multiple of 10.00 TRY
  • Payments are processed taking into account the working hours of the service from 08:00:00 to 04:00:00 (GMT + 3)
Onboarding and access fee Refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Hizli QR payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as the Hizli QR service.



Operations support

  Interfaces Amounts, TRY Times**
Payment Page CMS Plug-ins Gate Dashboard minimum maximum basic threshold
Purchases + + 100.00 up to 4,000.00 * 5 minutes 1 hour

* For more information refer to your ECommPay key account manager.

** The basic and threshold times are defined as follows:
  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

To perform a purchase by using the Hizli QR method, you need to redirect customer to the Hizli QR service.

Figure: Payment by using Payment Page



Figure: Payment by using Gate



The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Hizli QR method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Hizli QR method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence when using Payment Page

  1. Customer initiates purchase by using the web service.
  2. The merchant web service sends to the specified ECommPay URL the purchase request for Payment Page opening.
  3. The payment platform receives the request for processing the purchase by using Payment Page.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects Hizli QR payment method and agrees to use the method (or accepts the method already selected on Payment Page and agrees).
  8. The payment platform receives the purchase request for payment processing in the Hizli QR service.
  9. The payment platform performs the internal purchase request processing and sends it to the Hizli QR service.
  10. The purchase request is processed on the Hizli QR side.
  11. The Hizli QR service generates the data for redirecting the customer to the Hizli QR form and sends it to the payment platform.
  12. The payment platform sends to Payment Page the data for redirecting the customer to the Hizli QR service.
  13. The customer is redirected to the Hizli QR service.
  14. The customer selects a bank for purchase performing and completes required steps to perform purchase.
  15. The payment is processed on the Hizli QR side.
  16. The result is displayed to the customer in the Hizli QR service.
  17. The customer is redirected to Payment Page.
  18. Hizli QR service sends the payment result notification to the payment platform.
  19. The payment platform sends the callback to the web service.
  20. The payment platform sends payment results to Payment Page.
  21. A page with the payment result information is displayed to the customer.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Hizli QR payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, seePayment Page API Description.

Request format

There are several things you must consider when using the Hizli QR method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_amount—payment amount in minor units
    • payment_currency—payment currency in ISO-4217 alpha-3 format
  2. The currency of payment can only be TRY.
  3. Additionally pass the customer data parameters:
    • email—email address
    • first_name—first name
    • last_name—last name
    • day_of_birth—date of birth
    • billing.address— the street, number of house/apartment of the billing address
    • billing.city—the city of the billing address
    • billing.country—the country of the billing address
    • billing.postal—the postal code of the billing address
    If the parameters are absent in the request, they are requested from the customer on Payment Page.
  4. The billing country of a customer can only be Turkey: customer_billing_country: "TR".
  5. If you need to have payment form displayed with the Hizli QR method selected, set the force_payment_method parameter to hizliqr.
  6. If required, you can also add any other additional parameters Payment Page supports.
  7. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Hizli QR method must include project, customer and payment IDs, language code, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { payment_id: 'TEST_154', 
      payment_amount: 10000, 
      payment_currency: 'TRY,
      customer_id: '123', 
      project_id: 818,
      signature: "xq9k0XaXE0Ig0s%2B4%2BM2gtmkytwe3%2BP1pzXNsug19oD1upt%2F%2BABrIsG37IPKbfw%3D%3D"
    }
)

For information about all parameters available in the Hizli QR method, see Payment Page invocation parameters.

Callback format

In the Hizli QR method, the callbacks that deliver purchase results use the standard format described in Callbacks.

Here is an example of callback with an information about successful 100.00 TRY purchase made by the customer in the 818 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 818,
        "payment": {
            "id": "ORDER_ID_gev",
            "type": "purchase",
            "status": "success",
            "date": "2019-05-30T07:48:26+0000",
            "method": "hizli",
            "sum": {
                "amount": 10000,
                "currency": "TRY"
            },
            "description": "u0443"
        },
        "customer": {
            "id": "Tyrkman"
        },
        "operation": {
            "id": 1246,
            "type": "sale",
            "status": "success",
            "date": "2019-05-30T07:48:27+0000",
            "created_date": "2019-05-30T07:48:09+0000",
            "request_id": "6cb000fda4402a4c7f9f301eec3d8d52",
            "sum_initial": {
                "amount": 10000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1404,
                "payment_id": "19gla-39nzp7uhwc-5aYk",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "H9j5S+t+jKeVs717ET765vHJKIISkNb4YdkIeJCFhJxiKNLstiVoAUrWbDAHSQ=="
    }

The following example of callback is for a declined payment.

Figure: Example of a declined purchase callback

 {
        "project_id": 818,
        "payment": {
            "id": "ORDER_ID_gev",
            "type": "purchase",
            "status": "decline",
            "date": "2019-05-30T07:49:33+0000",
            "method": "hizli",
            "sum": {
                "amount": 101000,
                "currency": "TRY"
            },
            "description": "u043d"
        },
        "customer": {
            "id": "Tyrkman"
        },
        "operation": {
            "id": 2000001261,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-27T10:58:26+0000",
            "created_date": "2019-03-27T10:58:23+0000",
            "request_id": "65a09bb143bc051a9fa326155ac509768",
            "sum_initial": {
                "amount": 101000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 101000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1404,
                "payment_id": "19gla-39nzp7uhwc",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "Hn53oZbiN1/yTQXuMuLih+ojsDgarVO2K8h7uqYpyKJDayaAjnFGm1PFkqCA+E/nVQ1Hcg=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the Hizli QR method, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform redirecting customer to the Hizli QR form.
  3. Get the callback with the payment result from the payment platform.


Figure: Purchase sequence in the Payment Page method:

  1. Customer initiates purchase on the merchant web service by using Hizli QR method.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase by using Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends to the web service response with request receipt confirmation and correctness check result.
  6. The payment platform performs the internal payment request processing and sends it to the Hizli QR service.
  7. The purchase request is processed on the Hizli QR side.
  8. The Hizli QR service generates the data for redirecting the customer to the Hizli QR form and sends it to the payment platform.
  9. The payment platform sends to the web service the callback that delivers the data for redirecting customer to the Hizli QR service.
  10. The customer is redirected to the Hizli QR service.
  11. The customer selects a bank for purchase performing and completes required steps to perform purchase.
  12. The payment is processed on the Hizli QR side.
  13. The result is displayed to the customer in the Hizli QR service.
  14. The Hizli QR service sends the payment result notification to the payment platform.
  15. The payment platform sends the callback to the web service.
  16. The customer receives the payment result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Hizli QR payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results.

Request format

There are several things you must consider when using purchase requests in the Hizli QR method:
  1. You send purchase requests by sending the v2/payment/turkey-qr/hizli/sale request by using HTTP method POST. This is a request group: /v2/payment/turkey-qr/{payment_method}/sale.
  2. The following objects and parameters must be specified in any request:
    • general—object that contains general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • customer—object that contains customer information:
      • id—the unique ID of the customer within your project
      • ip_address—customer IP address
      • email—email address
      • first_name—first name
      • last_name—last name
      • day_of_birth—date of birth
      • billing.address— the street, number of house/apartment of the billing address
      • billing.city—the city of the billing address
      • billing.country—the country of the billing address
      • billing.postal—the postal code of the billing address
    • payment—object that contains purchase information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
    • Object return_url—URL for redirecting a customer from the bank website:
      • success—URL for redirecting a customer after a performed purchase
  3. The currency of purchase can only be TRY.
  4. The billing country of a customer can only be Turkey: customer.billing_country: "TR".
  5. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Hizli QR method must include project, customer and payment IDs, IP address, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
  "general": {
    "project_id": 818,
    "payment_id": "ORDER_ID_gev",
    "signature": "+K6jllym+PtObocZ1ySEmETmkJdsfgaGp+3bWA4NcWxfWJTXdESkijfsBeR6bKROUsslA=="
  },
  "customer": {
    "id": "theBestCustomer",
    "email": "turkeyqr@trpay.tr",
    "first_name": "Itan",
    "last_name": "Tyrkman",
    "billing": {
      "country": "TR",
      "city": "Antalia",
      "address": "Street 10, 22",
      "postal": "1545645"
    },
    "day_of_birth": "03-11-2002",
    "ip_address": "1.2.3.4"
  },
  "payment": {
    "amount": 51000,
    "currency": "TRY"
  },
  "return_url": {
    "success": "https://yandex.ru"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Hizli QR service, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in theredirect_data.body parameter, and use these parameters when opening the bank’s HTML page using method specified in the redirect_data.method parameter.

The following is the callback fragment containing the token for purchase.

"redirect_data": {
    "method": "GET",
    "body": {
      "status": "PENDING",
      "amount": "10000",
      "currency": "TRY",
      "type": "DEPOSIT",
      "referenceNo": "100000",
      "operation": "DIRECT",
      "returnUrl": "https://test.tr",
      "paymentMethod": "QRCODE",
      "transactionId": "7rwvs-vd9z3b4gnu-rb",
      "message": "Waiting",
      "code": "283",
      "language": "en",
      "purchaseUrl": "http://hizli/a/redirect?referenceNo=100000&returnUrl=https://test.tr"
    },
    "encrypted": [],
    "url": "http://hizli/a/redirect?referenceNo=100000&returnUrl=https://test.tr"
  },

Callback format

The Hizli QR method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

Here is an example of callback with an information about successful 100.00 TRY purchase made by the customer in the 818 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 818,
        "payment": {
            "id": "ORDER_ID_gev",
            "type": "purchase",
            "status": "success",
            "date": "2019-05-30T07:48:26+0000",
            "method": "hizli",
            "sum": {
                "amount": 10000,
                "currency": "TRY"
            },
            "description": "u0443"
        },
        "customer": {
            "id": "Tyrkman"
        },
        "operation": {
            "id": 1246,
            "type": "sale",
            "status": "success",
            "date": "2019-05-30T07:48:27+0000",
            "created_date": "2019-05-30T07:48:09+0000",
            "request_id": "6cb000fda4402a4c7f9f301eec3d8d52",
            "sum_initial": {
                "amount": 10000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1404,
                "payment_id": "19gla-39nzp7uhwc-5aYk",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "H9j5S+t+jKeVs717ET765vHJKIISkNb4YdkIeJCFhJxiKNLstiVoAUrWbDAHSQ=="
    }

The following example of callback is for a declined payment.

Figure: Example of a declined purchase callback

 {
        "project_id": 818,
        "payment": {
            "id": "ORDER_ID_gev",
            "type": "purchase",
            "status": "decline",
            "date": "2019-05-30T07:49:33+0000",
            "method": "hizli",
            "sum": {
                "amount": 101000,
                "currency": "TRY"
            },
            "description": "u043d"
        },
        "customer": {
            "id": "Tyrkman"
        },
        "operation": {
            "id": 2000001261,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-27T10:58:26+0000",
            "created_date": "2019-03-27T10:58:23+0000",
            "request_id": "65a09bb143bc051a9fa326155ac509768",
            "sum_initial": {
                "amount": 101000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 101000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1404,
                "payment_id": "19gla-39nzp7uhwc",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "Hn53oZbiN1/yTQXuMuLih+ojsDgarVO2K8h7uqYpyKJDayaAjnFGm1PFkqCA+E/nVQ1Hcg=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Hizli QR method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.