POST
/
v2.01
/
{ClientId}
/
payins
/
payment-methods
/
blik
{
    "AuthorId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
    "CreditedWalletId": "wlt_m_01HWSSQV8W6550FJ5NTJQE1DE1",
    "DebitedFunds": {
        "Currency": "PLN",
        "Amount": 100
    },
    "Fees": {
        "Currency": "PLN",
        "Amount": 0
    },
    "ReturnUrl": "https://www.mangopay.com/docs/please-ignore",
    "Tag": "Created using the Mangopay API Postman collection",
    "StatementDescriptor": "May2024"
}
  

{
    "Id": "wt_dbb46bf7-71e1-463c-bbd5-8217f3c4b474",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1715610590,
    "AuthorId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
    "DebitedFunds": {
        "Currency": "PLN",
        "Amount": 100
    },
    "CreditedFunds": {
        "Currency": "PLN",
        "Amount": 100
    },
    "Fees": {
        "Currency": "PLN",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HWSSQV8W6550FJ5NTJQE1DE1",
    "CreditedUserId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
    "PaymentType": "BLIK",
    "ExecutionType": "WEB",
    "ReturnURL": "https://www.mangopay.com/docs/please-ignore?transactionId=wt_dbb46bf7-71e1-463c-bbd5-8217f3c4b474",
    "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=2246577013&rs=D4a2bjG5roOlXDEvsBOdb2NoCNtPxxKZ&cs=f3452531239c64143ec6a9ccd382553ec71a987cdcdc16a4f2046bc5e3b8d373",
    "StatementDescriptor": "May2024",
    "Code": null,
    "BrowserInfo": null,
    "IpAddress": null
}

​
Body parameters

​
AuthorId
string
required
The unique identifier of the user at the source of the transaction.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
​
CreditedWalletId
string
required
The unique identifier of the credited wallet.
​
DebitedFunds
object
required
Information about the debited funds.
​
Fees
object
required
Information about the fees.
​
ReturnURL
string
required
Max. length: 255 charactersThe 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 spacesCustom 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.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
​
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
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
object
Information about the fees.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe 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, PAYOUTThe type of the transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
PaymentType
string
Returned values: BLIKThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
ReturnURL
string
Max. length: 255 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
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.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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.
​
Code
string
The 6-digit code from the user’s banking application.
​
BrowserInfo
object
Information about the browser used by the end user (author) to perform the payment.
​
IpAddress
string
The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
{
    "Id": "wt_dbb46bf7-71e1-463c-bbd5-8217f3c4b474",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1715610590,
    "AuthorId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
    "DebitedFunds": {
        "Currency": "PLN",
        "Amount": 100
    },
    "CreditedFunds": {
        "Currency": "PLN",
        "Amount": 100
    },
    "Fees": {
        "Currency": "PLN",
        "Amount": 0
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01HWSSQV8W6550FJ5NTJQE1DE1",
    "CreditedUserId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
    "PaymentType": "BLIK",
    "ExecutionType": "WEB",
    "ReturnURL": "https://www.mangopay.com/docs/please-ignore?transactionId=wt_dbb46bf7-71e1-463c-bbd5-8217f3c4b474",
    "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=2246577013&rs=D4a2bjG5roOlXDEvsBOdb2NoCNtPxxKZ&cs=f3452531239c64143ec6a9ccd382553ec71a987cdcdc16a4f2046bc5e3b8d373",
    "StatementDescriptor": "May2024",
    "Code": null,
    "BrowserInfo": null,
    "IpAddress": null
}

{
    "AuthorId": "user_m_01HWSRS7HK6S0XKKD4CJM3PQ04",
    "CreditedWalletId": "wlt_m_01HWSSQV8W6550FJ5NTJQE1DE1",
    "DebitedFunds": {
        "Currency": "PLN",
        "Amount": 100
    },
    "Fees": {
        "Currency": "PLN",
        "Amount": 0
    },
    "ReturnUrl": "https://www.mangopay.com/docs/please-ignore",
    "Tag": "Created using the Mangopay API Postman collection",
    "StatementDescriptor": "May2024"
}