Create a Bancontact PayIn

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

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

The unique identifier of the credited wallet.

Max. length: 255 characters

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

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.

Whether or not the pay-in forms part of a Bancontact recurring payment flow (not yet available).

Allowed values: One of the supported languages in the ISO 639-1 format: DE, EN, FR, NL

Default value: FR

The language in which the Bancontact payment page is to be displayed.

Allowed values: WEB, APP

Default value: WEB

The platform environment of the post-payment flow. The PaymentFlow value combines with the ReturnURL to manage the redirection behavior after payment:

• Set the value to APP to send the user to your platform's mobile app
• Set the value to WEB to send the user to a web browser

In both cases you need to provide the relevant ReturnURL, whether to your app or website.

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

The unique identifier of the object.

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

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

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

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

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.

The explanation of the result code.

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.

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

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.

The unique identifier of the credited wallet.

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

The unique identifier of the user whose wallet is credited.

Returned values: BCMC

The payment type of the pay-in.

Returned values: WEB

The execution type of the pay-in.

Max. length: 255 characters

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

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.

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.

Whether or not the pay-in forms part of a Bancontact recurring payment flow (not yet available).

Allowed values: One of the supported languages in the ISO 639-1 format: DE, EN, FR, NL

Default value: FR

The language in which the Bancontact payment page is to be displayed.

Allowed values: WEB, APP

Default value: WEB

The platform environment of the post-payment flow. The PaymentFlow value combines with the ReturnURL to manage the redirection behavior after payment:

• Set the value to APP to send the user to your platform's mobile app
• Set the value to WEB to send the user to a web browser

In both cases you need to provide the relevant ReturnURL, whether to your app or website.

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.