APM pay-insBLIK

The BLIK PayIn object

Description

The BLIK PayIn object enables you to process BLIK payments.

There are two BLIK pay-in options:

  • With code (also known as BLIK Classic): users generate a temporary 6-digit BLIK code from their banking app, enter it on your platform’s website or app, and then confirm the payment in their banking app.
  • Without code (also known as BLIK OneClick): after generating the temporary 6-digit BLIK code and confirming the payment, the users can save your platform which allows future payments to be processed directly.

For both options, the endpoint is the same but the parameters required are different in each case.

Note – Timeout after 55 seconds

The payment session lasts for 55 seconds, at which point the pay-in fails automatically if no action has been taken by the user.

Note – Minimum amount in Production

In Production, the minimum accepted amount for BLIK is 0.01 PLN (1).

Attributes

Id
string

The unique identifier of the object.

Tag
string

Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag parameter and will not be editable.

CreationDate
Unix timestamp

The date and time at which the object was created.

AuthorId
string

The unique identifier of the user at the source of the transaction.

DebitedFunds
objectRequired

Information about the debited funds. Please note that:

  • The Currency must be identical to that of the initial transaction.
  • The Amount cannot exceed the initial’s transaction minus the fees.
Currency
stringRequired

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount
integerRequired

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedFunds
object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Currency
string

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the wallets to take into account.

Amount
integerRequired

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees
objectRequired

Information about the fees. Please note that:

  • The Currency must be identical to that of the initial transaction.
  • The Amount cannot exceed the initial’s transaction.
Currency
stringRequired

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount
integerRequired

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

IpAddress
stringRequired

The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.

Code
stringRequired

The 6-digit code from the user’s banking application.

Status
string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCode
string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage
string

The explanation of the result code.

ExecutionDate
Unix timestamp

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Type
string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature
array

Allowed values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The transaction natures to be taken into account.

  • REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
  • REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
  • REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
  • SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.
CreditedWalletId
stringRequired

The unique identifier of the credited wallet (in the buy currency).

PaymentType
string

Returned values: BLIK

The type of pay-in.

ExecutionType
string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

RedirectURL
string

The URL to which to redirect the user to complete the payment.

Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.

ReturnURL
stringRequired

Max. length: 220 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.

StatementDescriptor
string

Max. length: 10 characters; only alphanumeric and spaces
Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.

BrowserInfo
object

Information about the browser used by the end user (author) to perform the payment.

UserAgent
stringRequired

Max. length: 255 characters
The exact content of the HTTP User-Agent header.

Guide

Learn more about BLIK