The Bancontact PayIn object
Description
The Bancontact PayIn object allows platforms to process payments with Bancontact made by scanning a QR code, or by using a Bancontact-branded card (that is not saved). Read the guide →
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: BCMC
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.
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.
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
APPto send the user to your platform’s mobile app - Set the value to
WEBto 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.