Create a BLIK PayIn

POST

/v2.01/:ClientId/payins/payment-methods/blik

POST

/v2.01/:ClientId/payins/payment-methods/blik

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/payment-methods/blik \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
>     "CreditedWalletId": "wlt_m_01HWSSQV8W6550FJ5NTJQE1DE1",
>     "DebitedFunds": {
>       "Currency": "PLN",
>       "Amount": 100
>     },
>     "Fees": {
>       "Currency": "PLN",
>       "Amount": 0
>     },
>     "Code": "777365",
>     "IpAddress": "159.180.248.187",
>     "ReturnURL": "https://www.mangopay.com/docs/please-ignore",
>     "BrowserInfo": {
>       "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
>       "JavascriptEnabled": true
>     },
>     "Tag": "Created using Mangopay API Collection Postman",
>     "StatementDescriptor": "May2024"
>   }
> }'

200Blik with code

1 {
2   "Id": "wt_54874ce5-751d-4616-b7f0-7cee68aee39d",
3   "Tag": "Created using Mangopay API Collection Postman",
4   "CreationDate": 1718178213,
5   "AuthorId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
6   "DebitedFunds": {
7     "Currency": "PLN",
8     "Amount": 100
9   },
10   "CreditedFunds": {
11     "Currency": "PLN",
12     "Amount": 100
13   },
14   "Fees": {
15     "Currency": "PLN",
16     "Amount": 0
17   },
18   "Status": "CREATED",
19   "ResultCode": null,
20   "ResultMessage": null,
21   "ExecutionDate": null,
22   "Type": "PAYIN",
23   "Nature": "REGULAR",
24   "CreditedWalletId": "wlt_m_01HWSSQV8W6550FJ5NTJQE1DE1",
25   "PaymentType": "BLIK",
26   "ExecutionType": "WEB",
27   "ReturnURL": "https://www.mangopay.com/docs/please-ignore?transactionId=wt_54874ce5-751d-4616-b7f0-7cee68aee39d",
28   "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=2263480064&rs=It3FPwW1ezPJlRIb84DFwDj2S7pk8n80&cs=2b704ceaa038b2519137369f883d4b560e63cf490adcc8e2426ae45524c965e9",
29   "StatementDescriptor": "May2024",
30   "Code": "777365",
31   "BrowserInfo": null,
32   "IpAddress": "159.180.248.187",
33   "CreditedUserId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04"
34 }

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

<Note icon="fa-regular fa-circle-info"> **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> <Note icon="fa-regular fa-circle-info"> **Note – Minimum amount in Production** In Production, the minimum accepted amount for BLIK is 0.01 PLN (`1`). </Note>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

BLIK PayIn with codeobjectRequired

BLIK pay-in request body including the code generated by the user in their app.

BLIK PayIn without codeobjectRequired

BLIK pay-in request body if the user has previously saved your platform, relying only on redirection.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstring

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

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

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

Feesobject

Information about the fees.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

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

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction, providing more information about the context in which the transaction occurred:

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

PaymentTypestring

Returned values: BLIK

The payment type of the pay-in.

ExecutionTypestring

Returned values: WEB

The execution type of the pay-in.

ReturnURLstring

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

RedirectURLstring

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.

StatementDescriptorstring

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.

Codestring or null

The 6-digit code sent in the request (otherwise returned null).

BrowserInfoobject or null

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

IpAddressstring or null

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