The Payconiq PayIn object
Description
The Payconiq PayIn object allows platforms to process payments made with their Payconiq mobile app, or via banking apps that support Payconiq.
Deprecated – Payconiq discontinued from Dec 4, 2025
Following its acquisition by the European Payments Initiative (EPI), the Payconiq brand and services are being phased out (read more on Payconiq’s website).
The timeline is as follows:
- Dec 4, 2025 - Payconiq pay-ins attempted after 12:00 noon CET will fail
- Dec 31, 2025 - Final day for processing pay-in refunds
- Jan 1, 2026 - Refunds possible using payouts (see guide)
Platforms using Payconiq are invited to integrate Bancontact, which allows users to continue paying with their Payconiq by Bancontact mobile app via the DeepLinkURL.
Attributes
The unique identifier of the object.
Max. length: 255 characters
Custom 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.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Best practice: When the payout author is different from the bank account owner, the Payout AuthorId value must be different from the Bank Account UserId value as well. Otherwise, Mangopay’s Compliance team will reject the payout.
Information about the debited funds.
properties
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.
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).
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
properties
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.
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).
Information about the fees.
properties
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.
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).
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
The unique identifier of the credited wallet (in the buy currency).
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Returned values: PAYCONIQ
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
Max. length: 255 characters
The URL to which the user is automatically returned after indicating that they have noted their Multibanco payment reference.
The URL to which to redirect the user to complete the payment on a hosted page showing the QR code and Payconiq by Bancontact branding and instructions.
Note: In Sandbox, this value redirects to Mangopay’s web-based simulator.
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.
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.
Allowed values: BE, LU
The country of residence of the user.
The mobile URL to which to redirect the user to complete the payment in an app-to-app flow.
Note: In Sandbox, this value is a placeholder: the RedirectURL must be used to complete the payment using Mangopay’s web-based simulator.
The URL of a page containing only the QR code which you can use in your payment experience.
You can lightly customize the QR code’s format, size, and color by adding query parameters to the QRCodeURL before redirecting the user. See the Payconiq guide for details.
Note: In Sandbox, this value is a placeholder. The RedirectURL must be used to complete the payment using Mangopay’s web-based simulator.