Blik
Overview
Introduction
Blik is a payment method which allows you to process payments in zloty by using bank accounts in Poland. This method supports purchases and refunds.
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 ecommpay key account manager; additional information is available in ecommshop |
Interaction diagram
Payment processing by using the Blik method involves the merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, and technical facilities of the Blik service.
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—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 | – | – | – | – |
- Amount limits and payment processing times depend on banks.
- 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
To perform a purchase by using the Blik method, you need to redirect the customer to the Blik service, while to make a refund, you need to receive a request from the customer and notify the customer about the result of the refund via the web service.
Purchase by using Payment Page
General information
To process a purchase through Payment Page by using the Blik method, the merchant's 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.
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:
- The following parameters required for any payment must be specified:
project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectpayment_currency
—payment currency code in the ISO-4217 alpha-3 formatpayment_amount
—payment amount in the smallest currency unitcustomer_id
—customer identifier unique within the project
- The following parameters required for any payment must be specified:
project_id
,payment_id
,payment_currency
,payment_amount
,customer_id
. - It is recommended to specify the name and e-mail address of the customer in the
customer_email
andcustomer_last_name
parameters. To avoid errors during payment processing it is recommended to use from 3 to 100 characters when specifying the value of thecustomer_last_name
parameter. If any of these parameters are missing, the payment form may display input fields for entering the missing values (details are available in Submission of additional payment information). - The currency of payment can only be PLN.
- If you need to have payment form displayed with the Blik method selected, set the
force_payment_method
parameter toblik
. - Additionally, any other parameters available for working with Payment Page can be used (details).
- After all target parameters are specified, generate a signature (details).
Thus, a correct request for opening the payment form using the Blik method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.
Callback format
The Blik method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with information about a 1.00 PLN
purchase made in the 423
project.
The following is the example of a callback with information about a declined purchase.
Useful links
The following articles can be useful when implementing purchases via Payment Page:
- Interaction concepts—how to organise interaction with the payment platform by using Payment Page
- Signature generation and verification—about the procedure of creating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
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:
- Send a request with all the required parameters and signature to the ecommpay URL.
- Receive an intermediate callback from the payment platform and redirect the customer to the Blik service.
- Receive the final callback from the payment platform.
The full sequence and special aspects of purchase processing are provided below.
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:
- To initiate each purchase, send a separate POST request to the /v2/payment/blik/sale endpoint.
- Each request must include the following objects and parameters:
- Object
general
—general purchase information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectsignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
- Object
payment
—payment information:amount
—payment amount in the smallest currency unitcurrency
—payment currency code in the ISO-4217 alpha-3 format
- Object
customer
—customer information:id
—customer identifier unique within the projectip_address
—customer IP address relevant for the initiated payment
- Object
- It is recommended to specify the last name and email address of the customer.
- 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
If any of these parameters are missing, the payment platform may send the list of missing parameters in a callback requesting additional information submission (details are available in Submission of additional payment information).
- Object
- 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.
- The currency of purchase can only be PLN.
- Additionally, any other parameters included in the specification can be used.
Thus, a correct purchase request by using the Blik method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.
Formats of intermediate callbacks for customer redirection
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 bodymethod
—parameter specifying the HTTP method for sending the request (GET
orPOST
)url
—parameter containing a link for redirection
Final callback format
The Blik method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.
The following is the example of a callback with information about a 1.00 PLN
purchase made in the 423
project.
The following is the example of a callback with information about a declined purchase.
Useful links
The following articles can be useful when implementing purchases via Gate:
- Interaction concepts—how to organise interaction with the payment platform by using Gate
- Signature generation and verification—about the procedure of creating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
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.
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:
- To initiate each refund, send a separate POST request to the /v2/payment/blik/refund endpoint.
- Each request must include the following objects and parameters:
- Object
general
—general refund information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—identifier of the payment that needs to be refundedpayment identifiersignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
- Object
payment
—refund information:description
—refund description or commentamount
—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
- 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, signature, and, if necessary, currency code and refund amount.
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.
Useful links
The following articles can be useful when implementing refunds via Gate:
- Interaction concepts—how to organise interaction with the payment platform by using Gate
- Signature generation and verification—about the procedure of creating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- Purchase refunds—about performing of refunds by using Gate.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
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 and 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 available by using the Data API interface.
If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.