Blik

Overview

Introduction

Blikis a payment method that uses the online banking mechanism for payments through banks of Poland. This method supports purchases and refunds.

Blikis a payment method that uses the online banking mechanism for payments through banks of Poland.

This article provides information about working with the Blik method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type bank payments
Payment instruments bank accounts
Countries and regions PL
Payment currencies PLN
Currency conversion –
One-time purchases +
Credential-on-file purchases –
Full refunds +
Partial refunds +
Payouts –
Chargebacks –
Notes the way of opening a payment form on the Blik website—any way except an iframe object
Obtaining access to the payment method and access fee refer to your key account manager ecommpay

Interaction diagram

Payment processing by using the Blik method involves the merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as Blik technical facilities.



Operations support

Various platform interfaces can be used to process payments and perform operations using the Blik method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), refunds and payouts—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable to all operationsapplicable.

  Amounts, PLN ¹ Times ²
minimum maximum basic threshold
Purchases 0.01 10 000.00* * *
Refunds – – – –
Note:
  1. Amount limits and payment processing times depend on banks.
  2. The base and threshold times are defined as follows:
    • The base 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 web service. The base 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 the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

In the Blik method, purchases and refunds follow different processing procedures. To perform a purchase operation, you need to redirect customer to the Blik service, while to initiate a refund, you need to receive a request from the customer and notification from the web service side.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate



Figure: Refund by using Gate



Purchase by using Payment Page

General information

To process a purchase through Payment Page by using the Blik method, the merchant web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Payment Page: step-by-step description

  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project settings and parameters specified in the request.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Blik method.
  8. The request for processing the payment by using the Blik method is received by the payment platform.
  9. The payment platform processes the request and sends it to the Blik service.
  10. The request is processed on the side of the Blik service.
  11. The data for redirecting the customer to the Blik service is sent from the Blik service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the Blik service.
  14. The customer completes all required payment steps.
  15. The purchase is processed on the side of the Blik service.
  16. The result information is displayed to the customer in the Blik service.
  17. The customer is redirected to Payment Page.
  18. The Blik service sends a notification about the result to the payment platform.
  19. The payment platform sends the payment result callback to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the Blik method via Payment Page is presented further in this section. General information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Blik method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. It is recommended to specify the name and e-mail address of the customer in the customer_email and customer_last_name parameters. To avoid errors during payment processing it is recommended to use from 3 to 100 characters when specifying the value of the customer_last_name parameter. If the request is missing the parameter, the additional field to input missing data is displayed to the customer on Payment Page. For more details about clarification, see Submission of additional payment information.
  4. The currency of payment can only be PLN.
  5. If you need to have payment form displayed with the Blik method selected, set the force_payment_method parameter to blik.
  6. Additionally, any other parameters available for working with Payment Page can be used. See Parameters for opening payment form for information on all available parameters.Additionally, any other parameters available for working with Payment Page can be used (details).
  7. After all target parameters are specified, create a signature (details).

Thus, a correct payment request in the Blik method must include project, customer and payment IDs, the currency and the amount of a payment in the appropriate currency, as well the last name and email address of the customer.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "PLN",
   "customer_id": "customer1",
   "customer_last_name": "Johnson,
   "customer_email": "customer@example.com',
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

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

In the following example of the callback body, you can see that the purchase was completed.

Figure: Example of data in a purchase callback

{
        "project_id": 423,
        "payment": {
            "id": "03315",
            "type": "purchase",
            "status": "success",
            "date": "2022-05-12T14:32:59+0000",
            "method": "blik",
            "sum": {
                "amount": 100,
                "currency": "PLN"
            },
            "description": "PAYMENT_03315"
        },
            "customer": {
            "id": "11"
        },
        "operation": {
            "id": 50241,
            "type": "sale",
            "status": "success",
            "date": "2022-05-09T09:32:10+0000",
            "created_date": "2022-05-09T09:20:09+0000",
            "request_id": "6db6ed63860b74b33b0c870-00010993",
            "sum_initial": {
                "amount": 100,
                "currency": "PLN"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "PLN"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 151,
                "payment_id": "8464654",
                "auth_code": ""
            }
        },
        "signature": "5xpLaag4iVH4p5poiI25KSUQWESwbgfpLZ/gVj4fWfTzVBg=="
    }

In the following example of the callback body, you can see that the purchase was declined.

Figure: Example of data in a declined purchase callback

 {
        "project_id": 423,
        "payment": {
            "id": "3614",
            "type": "purchase",
            "status": "decline",
            "date": "2022-05-16T08:16:29+0000",
            "method": "blik",
            "sum": {
                "amount": 100,
                "currency": "PLN"
            },
            "description": "PAYMENT_3614"
        }, 
        "customer": {
            "id": "11"
        },
        "operation": {
            "id": 73761,
            "type": "sale",
            "status": "decline",
            "date": "2022-05-16T08:16:29+0000",
            "created_date": "2022-05-16T08:06:20+0000",
            "request_id": "b4aa45de7042c95b992e9a5ab874bfbcf-00051169",
            "sum_initial": {
                "amount": 100,
                "currency": "PLN"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "PLN"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 151,
                "payment_id": "600325",
                "auth_code": ""
            }
        },
        "signature": "wn7dHQhfVYLPZuVuzGfw1EJGZ5tHfS8oTW1EsxEhvJW6Tiw=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchase by using Gate

General information

To process a purchase through Gate by using the Blik method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the Blik service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Gate: step-by-step description

  1. A customer initiates a purchase by using the Blik method in the web service.
  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.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the Blik service.
  7. The request is processed on the Blik service side.
  8. The Blik service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the Blik service.
  11. The customer completes all required payment steps.
  12. The purchase is processed on the side of the Blik service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The Blik service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the Blik method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Blik method:

  1. To initiate each purchase, send a POST request to the /v2/payment/blik/sale endpoint.
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature created after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—IP address relevant for the initiated payment
  3. It is recommended to specify the last name and email address of the customer. If the request is missing the parameters, the list of parameters is sent in the clarification callback. For more details, see Submission of additional payment information. There is the list of recommended objects and parameters:
    • Object customer—customer information:
      • last_name—last name (to avoid errors during payment processing it is recommended to set the following value length—from 3 to 100 characters)
      • email—email
  4. If needed, you can also add URL for redirecting the customer to the web service:
    • return_url—URL for redirecting the customer to the web service:
      • return—URL for redirecting a customer while or after purchase performing.
  5. The currency of purchase can only be PLN.
  6. Additionally, any other parameters included in the specification can be used.

Thus, a correct payment request in the Blik method must include project, customer and payment IDs, amount and currency of the purchase, as well as customer data and URL for redirection.

Figure: Example of a purchase request

{
    "general": {
      "project_id": 423,
      "payment_id": "5554",
      "signature": "PJkV8ej\/UG0Di8LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 100,
      "currency": "PLN"
    },
    "customer": {
      "last_name": "Johnson",
      "id": "123",
      "ip_address": "192.0.2.0",
      "email": "customer@example.com"
    } 
}

Formats of the customer redirection data

Each payment made with the Blik method requires redirection of customers from the merchant's web service to the Blik service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection

Figure: redirect_data example

"redirect_data": {
                   "body": [],
                   "method": "GET",
                   "url": "https://example.com/bi/t0bc?tx=example"
}

Callback format

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

In the following example of the callback body, you can see that the purchase was completed.

Figure: Example of data in a purchase callback

{
        "project_id": 423,
        "payment": {
            "id": "03315",
            "type": "purchase",
            "status": "success",
            "date": "2022-05-12T14:32:59+0000",
            "method": "blik",
            "sum": {
                "amount": 100,
                "currency": "PLN"
            },
            "description": "PAYMENT_03315"
        },
            "customer": {
            "id": "11"
        },
        "operation": {
            "id": 50241,
            "type": "sale",
            "status": "success",
            "date": "2022-05-09T09:32:10+0000",
            "created_date": "2022-05-09T09:20:09+0000",
            "request_id": "6db6ed63860b74b33b0c870-00010993",
            "sum_initial": {
                "amount": 100,
                "currency": "PLN"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "PLN"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 151,
                "payment_id": "8464654",
                "auth_code": ""
            }
        },
        "signature": "5xpLaag4iVH4p5poESwbgfpLZ/gVj4fWfTzVBg=="
    }

In the following example of the callback body, you can see that the purchase was declined.

Figure: Example of data in a declined purchase callback

 {
        "project_id": 423,
        "payment": {
            "id": "3614",
            "type": "purchase",
            "status": "decline",
            "date": "2022-05-16T08:16:29+0000",
            "method": "blik",
            "sum": {
                "amount": 100,
                "currency": "PLN"
            },
            "description": "PAYMENT_3614"
        }, 
        "customer": {
            "id": "11"
        },
        "operation": {
            "id": 73761,
            "type": "sale",
            "status": "decline",
            "date": "2022-05-16T08:16:29+0000",
            "created_date": "2022-05-16T08:06:20+0000",
            "request_id": "b4aa45de7042c95b992e9a5ab874bfbcf-00051169",
            "sum_initial": {
                "amount": 100,
                "currency": "PLN"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "PLN"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 151,
                "payment_id": "600325",
                "auth_code": ""
            }
        },
        "signature": "wn7dHQhfVYLPZuVxZ5tHfS8oTW1EsxEhvJW6Tiw=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Refunds by using Gate

General information

To perform a refund through Gate by using the Blik method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of refund performing are provided below.



Figure: Refund performing by using Gate: step-by-step description

  1. A customer initiates a refund.
  2. The web service sends the request for performing the refund by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the Blik service.
  7. The refund is processed on the side of the Blik service.
  8. The Blik service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the refund result information from the web service.

Information about the formats of requests and callbacks used for performing refunds by using the Blik method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending refund requests by using the Blik method:

  1. To initiate each refund, send a POST request to the /v2/payment/blik/refund endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general refund information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—identifier of the payment that needs to be refundedpayment identifier
      • signature—request signature created after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—payment information:
      • description—refund description or comment
      • amount—refund amount in the smallest currency unit (required for a partial refund)
      • currency—refund currency code in the ISO-4217 alpha-3 format (required for a partial refund)
    • Object customer—customer information:
      • ip_address—IP address relevant for the initiated refund
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct refund request by using the Blik method must contain the project and payment identifiers, description of the refund, the customer IP address, signature, and, if necessary, currency code and refund amount.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "PLN"
  }
}

Callback format

The Blik method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 50.00 PLN refund to the user_33 customer in the 171 project.

Figure: Example of data in a refund callback

{
        "project_id": 171,
        "payment": {
            "id": "PAYMENT_6315",
            "type": "purchase",
            "status": "refunded",
            "date": "2022-05-12T14:32:59+0000",
            "method": "blik",
            "sum": {
                "amount": 0,
                "currency": "PLN"
            },
            "description": "REFUND_FOR_PAYMENT_6315"
        },
            "customer": {
            "id": "user_33"
        },
        "operation": {
            "id": 10992010050461,
            "type": "refund",
            "status": "success",
            "date": "2022-05-12T14:32:59+0000",
            "created_date": "2022-05-12T14:32:56+0000",
            "request_id": "1d970130f663c4639a2058a6b4727c9b710ddb3-00010993",
            "sum_initial": {
                "amount": 5000,
                "currency": "PLN"
            },
            "sum_converted": {
                "amount": 5000,
                "currency": "PLN"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 151,
                "payment_id": "151983",
                "auth_code": ""
            }
        },
        "signature": "TueTURmjrc9Vw2b1LtOG1NCCRA+UO0ov3wWc6ueXYUSTdxaZHj0w=="
    }

Useful links

The following articles can be useful when implementing refunds via Gate:

Refunds by using Dashboard

When working with Dashboard, you can perform single and mass refunds by using the Blik method.

  • To perform a single refund, select the target purchase, open its information tab, specify the amount of the refund, send a request and verify that the refund has been performed.

  • To perform a mass refund, prepare and upload a file with information about all target refunds, send a batch request, and verify that the refunds have been performed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The refund parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information Information about performing refunds by using Dashboard is presented in a separate section.

Analysis of payments results

To analyse information about payments made with the Blik method as well as other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL by using the Data API interface (details).

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.