Create a Web Card PayIn

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 unique identifier of the user at the source of the transaction.

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

The unique identifier of the user whose wallet is credited.

The unique identifier of the credited wallet.

Max length: 220 characters.

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

Allowed values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMC.

The type of the card.

Allowed values: One of the supported languages in the ISO 639-1 format: CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.

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

Allowed values: DEFAULT, FORCE, NO_CHOICE

Default value: DEFAULT

The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:

• DEFAULT – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.
• FORCE – Requests SCA.
• NO_CHOICE – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.

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.

The unique reference generated for the profiling session, used by the <a href="/guides/fraud-prevention">fraud prevention</a> 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 <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.

Deprecated. Allowed values: The BIC of a <a href="/guides/payment-methods/ideal">bank supported by iDEAL</a>.

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.

This field was used by legacy iDEAL integrations and is still accepted by the API for backwards compatibility. New integrations should use the dedicated <a href="/api-reference/ideal/create-ideal-payin">Create an iDEAL PayIn</a> endpoint instead.

Note: Parameter not returned – the BankName is returned instead.

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.

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

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

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

The unique identifier of the user whose wallet is credited.

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.

The unique identifier of the debited wallet.

In the case of a pay-in, this value is always null since there is no debited wallet.

Returned values: CARD

The payment type of the pay-in.

Returned values: WEB

The execution type of the pay-in.

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: 220 characters

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

Caution: This customization feature is deprecated and must no longer be used. You must redirect on the RedirectURL instead.

The customized URL to which to redirect the user to complete the payment.

Returned values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMC

The type of the card.

Returned values: One of the supported languages in the ISO 639-1 format: CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.

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

Returned values: DEFAULT, FORCE, NO_CHOICE

The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:

• DEFAULT – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.
• FORCE – Requests SCA.
• NO_CHOICE – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.

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.

The user’s bank, if the CardType is IDEAL, as defined by the Bic parameter sent in the call. This parameter is null for other card types or if the BIC was not sent on the legacy iDEAL implementation. See <a href="/api-reference/ideal/create-web-card-payin-ideal">Create a Web Card PayIn (iDEAL)</a> for more information.