Instant QR

Overview

Instant QR is a payment method that allows customers to perform payments by bank transfers. Purchases through this method are available by using Payment Page and Gate.

General information

Payment method type bank transfer
Countries and regions TR
Payment currencies TRY
Currency conversion on the ECommPay side
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes amounts are indicated with a zero decimal part; amounts with a non-zero decimal part are not allowed
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

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

Operations support

  Interfaces Amounts, TRY
Payment Page CMS Plugins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + + 50.00 * 3,000.00 *

* For the most recent amount limits, contact your ECommPay key account manager.

Processing scenarios

To perform a purchase operation, you need to redirect customer to the Instant QR service.

Figure: Purchase by using Payment Page

Figure: Purchase 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.

Purchases by using Payment Page

General information

In the Instant QR method, when processing 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 Instant 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 a purchase by using the web service.
  2. The merchant web service sends to the specified ECommPay URL the purchase request for processing the purchase by using Payment Page.
  3. The request for opening is redirected to the payment platform.
  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 the Instant QR method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the Instant QR service.
  10. The purchase request is processed on the Instant QR service side.
  11. The Instant QR service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the Instant QR website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the Instant QR side.
  16. The result is displayed to the customer on the Instant QR website.
  17. The customer is redirected to Payment Page.
  18. The Instant QR service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

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

Request format

There are several things you need to consider when using the Instant 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_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
  2. The folowing customer data needs to be specified on Payment Page.
    • customer_first_name—first name
    • customer_last_name—last name
    • customer_email—email
    • customer_country—country in the ISO 3166-1 alpha-2 format
    • customer_day_of_birth—date of birth in the DD-MM-YYYY format
  3. The currency of payment can only be TRY.
  4. If you need to have payment form displayed with the Instant QR method selected, set the force_payment_method parameter to instant-qr.
  5. If required, you can also add any other additional parameters Payment Page supports.
  6. 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 Instant QR method must include project, customer and payment IDs, the currency and the amount of a payment, as well as customer data and signature, as shown in the following example:

project_id: '398',
      payment_id: '115', 
      payment_currency: 'TRY',
      payment_amount: 10000,
      customer_id: '123',
      customer_first_name": "Mary",
      customer_last_name": "Smith",
      customer_email": "smith@example.com",
      customer_country": "TR",
      customer_day_of_birth": "12-12-1990",
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\
                         /RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="

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

Callback format

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

The following is the example of a callback containing information about successful 100.00 TRY purchase made in the 398 project.

Figure: Example of a successful purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "instant-qr",
            "sum": {
                "amount": 10000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 10000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

The following is the example of a callback for a purchase declined due to amount or frequency limitation.

Figure: Example of a declined purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "instant-qr",
            "sum": {
                "amount": 600000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 600000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 600000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

Related topics

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

Purchases by using Gate

General information

In the Instant 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 the redirection of a customer to the Instant QR service.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

Figure: Purchase sequence when using Gate

  1. A customer initiates a purchase on the merchant web service by using the Instant 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 from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Instant QR service.
  7. The request is processed on the Instant QR side.
  8. The Instant QR service sends the data for redirecting the customer to the Instant QR service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Instant QR service.
  11. The customer completes all the required payment steps.
  12. The payment is processed on the Instant QR side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The Instant QR service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

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

Request format

There are several things you must consider when using purchase requests in the Instant QR method:
  1. You send purchase requests by sending the request to /v2/payment/bank-transfer/instant-qr/sale by using POST (HTTP) method. This is a bank transfer requests group: /v2/payment/bank-transfer/{payment_method}/sale.
  2. The following objects and parameters must be specified in any request:
    • Object general—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.
    • Object payment—purchase information:
      • amount—purchase amount in minor units
      • currency—payment currency in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address
      • first_name—first name
      • last_name—last name
      • email—email
      • country—country in the ISO 3166-1 alpha-2 format
      • day_of_birth—date of birth in the DD-MM-YYYY format
    • Object return_url—the URLs to which the customer is redirected during or after the payment process:
      • success—after a successfully completed payment
      • decline—after a declined payment
  3. The currency of purchase can only be TRY.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Instant QR method must include project, customer and payment IDs, amount and currency of the purchase, customer data and URLs for customer redirection, as shown in the following example:

Figure: Example of a purchase request

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 10000,
    "currency": "TRY"
  },
  "customer": {
    "id": "123",
    "ip_address": "1.1.1.1",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "smith@example.com",
    "country": "TR",
    "day_of_birth": "12-12-1990"
  },
    "return_url": {
      "success": "http://example.com/success",
      "decline": "http://example.com/decline"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Instant QR site, 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 the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the the redirection data.

"redirect_data" : {
			"body" : [],
			"method" : "GET",
			"url" : "https://checkout.bestpaycard.com/example"
		}

Callback format

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

The following is the example of a callback containing information about successful 100.00 TRY purchase made in the 398 project.

Figure: Example of a successful purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "instant-qr",
            "sum": {
                "amount": 10000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 10000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

The following is the example of a callback for a purchase declined due to amount or frequency limitation.

Figure: Example of a declined purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "instant-qr",
            "sum": {
                "amount": 600000,
                "currency": "TRY"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 600000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 600000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

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 Instant 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.