The iDEAL PayIn object
Description
The iDEAL PayIn object allows platforms to process payments made with the iDEAL payment method.
Note – Activation required
To activate iDEAL for your platform (including Sandbox), contact Mangopay via the Hub.
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.
Information about the debited funds.
Information about the credited funds (CreditedFunds
= DebitedFunds
- Fees
).
Information about the fees.
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.
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: IDEAL
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 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 Customizing bank statement references article for details.
Allowed values: The BIC of a bank supported by iDEAL
The bank identifier code (BIC) of the user’s bank. If provided, the user is redirected to the bank’s interface to log in and authenticate the payment. If not provided, the user is redirected to an intermediary page where they must choose their bank.
Note: Parameter not returned – the BankName
is returned instead.
Returned values: The bank name corresponding to the Bic
sent, or null
if no Bic
sent.
The user’s bank, as defined by the Bic
parameter sent in the call.
The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.
Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay from the Hub for more information.
Related resources
Guide
Was this page helpful?