Blik

QP Integration option

Payment

Payment Flow

The customer initiates the payment on the merchant's website.
The merchant sends a payment request to Freepayment specifying the BLIK code.
Freepayment responds with a link to the payment page.
The merchant redirects the customer to the payment page.
The customer sees the spinner while the transaction is being completed and is then redirected to the return_url.

Info

This integration option supports only `PLN` currency.

Request

Send a payment request with the following additional data:

Parameter	Type	Description
request	object
return_url * required	string	URL to return the customer to when the transaction is completed.
ip * required	string	The customer's IP address.
method	object	A section of the payment method information.
type * required	string	`blik`
password * required	string (6)	The BLIK code generated in the customer's bank application. Must consist of 6 digits.
customer	object	A section of the customer details.
first_name * required	string	The customer's first name. Must contain only letters of the Latin alphabet. Must be between 2 and 50 symbols.
last_name * required	string	The customer's last name. Must contain only letters of the Latin alphabet. Must be between 2 and 50 symbols.
email * required	string	The customer's email address.
phone	string	The customer's phone number. `+` must be specified.

Request example

{
    "request":{
        "amount":13500,
        "currency":"PLN",
        "description":"description",
        "test":false,             
        "tracking_id":"your_uniq_number",
        "language":"en",
        "notification_url":"https://example.com/notification",
        "return_url":"https://example.com/return/",
        "ip": "127.200.00.0",
        "customer":{
            "email":"jan@example.com",                  
            "first_name": "Jan",
            "last_name" : "Kowalski"
        },
        "method":{
            "type":"blik",
            "password": "777777"
        }
    }
}

Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example

{
  "transaction": {
    "uid": "9b32fcba-f5eb-47bf-9ae5-4bbb8cf10072",
    "type": "payment",
    "status": "pending",
    "amount": 13500,
    "currency": "PLN",
    "description": "description",
    "created_at": "2024-10-09T12:29:57Z",
    "updated_at": "2024-10-09T12:29:59Z",
    "method_type": "blik",
    "receipt_url": "https://account.freepayment.online/customer/transactions/9b32fcba-f5eb-47bf-9ae5-4bbb8cf10072/042ad10c16b31828f97ea0e3a71c3371f6f1653a1100ba4e5ab3b00586dbeaaf?language=en",
    "payment": {
      "status": "pending",
      "gateway_id": 4544,
      "message": "Transaction was initialized.",
      "bank_code": ""
    },
    "blik": {
      "type": "blik",
      "password": "777777"
    },
    "customer": {
      "first_name": "Jan",
      "last_name": "Kowalski",
      "email": "jan@example.com",
      "ip": "127.200.00.0"
    },
    "manually_corrected_at": null,
    "version": 0,
    "message": "Transaction was initialized.",
    "tracking_id": "your_uniq_number",
    "test": false,
    "language": "en",
    "billing_address": {
      "first_name": "Jan",
      "last_name": "Kowalski",
      "email": "jan@example.com"
    },
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    },
    "form": {
      "action": "https://payment-page/redirect/to/269/251354/01T7HwrLOiTpujB6lpX6eiGOJruWdKbLr4iY4cpfvlTRceqsrXDy3UH7_9VU5r9ECz",
      "method": "GET",
      "fields": []
    }
  }
}

SS Integration option

Payment

Payment Flow

The customer initiates the payment on the merchant's website.
The merchant sends a payment request to Freepayment.
Freepayment responds with a link to the payment page.
The merchant redirects the customer to the payment page.
The customer completes the payment.
Freepayment sends a webhook notification with the payment status to the merchant.

Info

This integration option supports only PLN currency.

Request

Send a payment request with the following additional data:

Parameter	Type	Description
request	object
return_url * required	string	URL to return the customer to when the transaction is completed.
ip	string	The customer's IP address.
method	object	A section of the payment method information.
type * required	string	`blik`
customer	object	A section of information about the customer.
first_name	string	The customer's first name.
last_name	string	The customer's last name.
additional_data	object	A section of additional transaction parameters.
browser	object	A section of the customer's browser parameters.
accept_header	string	Value of `Accept` request HTTP header sent by the customer's browser.
screen_color_depth	integer	Screen color depth in bits per pixel. Equals the `screen.colorDepth` parameter in JavaScript. Applicable values are: `1` - 1 bit `4` - 4 bits `8` - 8 bits `15` - 15 bits `16` - 16 bits `24` - 24 bits `32` - 32 bits `48` - 48 bits.
language	string	Language of the navigator. Equals the `navigator.language` parameter in JavaScript.
screen_height	integer	Screen height in pixels. Equals the `screen.height` parameter in JavaScript.
screen_width	integer	Screen width in pixels. Equals the `screen.width` parameter in JavaScript.
time_zone	integer	Time zone difference, in minutes, from the current locale (host system settings) to UTC. Equals the `new Date().getTimezoneOffset()` parameter in JavaScript.
user_agent	string	User agent string for the browser. Equals the `navigator.userAgent` parameter in JavaScript.
java_enabled	boolean	Indicates if the browser is Java-enabled or not. Equals the `navigator.javaEnabled()` parameter in JavaScript.
window_width	integer	Browser window width in pixels. Equals the `document.body.clientWidth` parameter in JavaScript.
window_height	integer	Browser window height in pixels. Equals the `document.body.clientHeight` parameter in JavaScript.

Request example

{
  "request": {
    "amount": 5000,
    "currency": "PLN",
    "ip": "127.0.0.1",
    "description": "description",
    "return_url": "https://return.com",
    "method": {
      "type": "blik"
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "additional_data": {
      "browser": {
        "accept_header": "text/html,application/xhtml+xml,application/xml",
        "screen_color_depth": 24,
        "language": "en",
        "screen_height": 800,
        "screen_width": 600,
        "time_zone": -300,
        "user_agent": "AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0",
        "java_enabled": true,
        "window_width": 1024,
        "window_height": 640
      }
    }
  }
}

Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example

{
    "transaction": {
        "uid": "d7b88f80-f714-4f64-9aeb-dc880b3b7b4a",
        "type": "payment",
        "status": "pending",
        "amount": 2300,
        "currency": "PLN",
        "description": "test",
        "created_at": "2025-01-11T11:31:09Z",
        "updated_at": "2025-01-11T11:31:10Z",
        "method_type": "blik",
        "receipt_url": "https://account.freepayment.online/customer/transactions/d7b88f80-f714-4f64-9aeb-dc880b3b7b4a/e598bbe9b8a2deaf99fbcefca028f6c6c2b7eedf593d3ee37151e9acd61844da?language=ru",
        "payment": {
            "status": "pending",
            "gateway_id": 4824,
            "ref_id": "4214474",
            "message": "Invoice is created successfully, waiting for a payment",
            "bank_code": 31
        },
        "blik": {
            "type": "blik"
        },
        "customer": {
            "email": null,
            "ip": null
        },
        "manually_corrected_at": null,
        "version": 0,
        "message": "Invoice is created successfully, waiting for a payment",
        "tracking_id": "your_uniq_number21212",
        "test": true,
        "language": "en",
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        },
        "gateway": {
            "iframe": false
        },
        "form": {
            "action": "https://test-ss/hosted?transaction-id=5e747509-4b2e-8a0a-03ea-5697eb",
            "method": "GET",
            "fields": []
        }
    }
}