v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

Payconiq

Create a Payconiq PayIn

<Warning icon="fa-regular fa-triangle-exclamation"> **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 (<a href="https://www.payconiq.be/en/payconiq-evolves" target="_blank">read more</a> 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. </Warning>

<Note icon="fa-regular fa-circle-info"> **Note – Timeout after 1 hour**

The Payconiq payment session lasts for 1 hour, at which point the pay-in fails automatically if no action has been taken by the user. </Note>

Create a Payconiq PayIn

post/v2.01/{ClientId}/payins/payment-methods/payconiq

Path parameters

ClientIdstring required

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

Headers

Authorizationstring required

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.

Request body

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

AuthorIdstring required

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

CreditedWalletIdstring required

The unique identifier of the credited wallet.

ReturnURLstring required

Max. length: 255 characters

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

Countrystring required

Allowed values: BE, LU

The country of residence of the user.

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 <a href="/bank-statements">Customizing bank statement references</a> article for details.

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.

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 <a href="/errors/codes">handle errors</a> 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.

CreditedUserIdstring

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

PaymentTypestring

Returned values: PAYCONIQ

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

StatementDescriptorstring

Max. length: 10 characters; only alphanumeric and spaces

Countrystring

Returned values: BE, LU

The country of residence of the user.

DeepLinkURLstring

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.

QRCodeURLstring

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 <a href="/guides/payment-methods/payconiq">Payconiq guide</a> 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.