Skip to main content
POST
/
v2.01
/
{ClientId}
/
payins
/
card
/
web
{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 12000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "CreditedWalletId": "204068186",
    "ReturnURL": "https://docs.mangopay.com/please-ignore",
    "CardType": "IDEAL",
    "Culture": "EN",
    "Bic": "BITSNL2A"
}  

{
    "Id": "wt_144da3b7-b6b0-4438-9a7c-75a9695a1816",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1701296081,
    "AuthorId": "204068024",
    "CreditedUserId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 12000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 11000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "204068186",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=140149714181&rs=PyFMwmikCotrnVEf50EQx9jR9Ib38oMG&cs=3d5141c0cf871b4c8a6a53e635a39ebaabbf1e76093fa19bcba331728381b005",
    "ReturnURL": "https://docs.mangopay.com/please-ignore?transactionId=wt_144da3b7-b6b0-4438-9a7c-75a9695a1816",
    "TemplateURL": null,
    "CardType": "IDEAL",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": null,
    "Shipping": null,
    "StatementDescriptor": null,
    "BankName": "Yoursafe"
}
Warning – Deprecated legacy integrationThis endpoint is the legacy integration of iDEAL with Mangopay as a Web Card PayIn with the CardType IDEAL. If you are integrating iDEAL for the first time, use the Create an iDEAL PayIn endpoint.The legacy integration continues to be supported for platforms who had already integrated iDEAL, with no changes required on their side. The Bic parameter, enabling bank selection, can be added to legacy integrations. For more information, see the iDEAL article.

​
Body parameters

​
Tag
string
Max. length: 255 charactersCustom 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.
​
AuthorId
string
required
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
required
Information about the debited funds.
​
Fees
object
required
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
ReturnURL
string
required
Max. length: 220 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
CreditedWalletId
string
required
The unique identifier of the credited wallet.
​
CardType
string
required
Allowed values: IDEALThe type of card.
​
Culture
string
required
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.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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.
​
ProfilingAttemptReference
string
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 via the Dashboard for more information.
​
Bic
string
Allowed values: The BIC of a bank supported by iDEALThe 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.

​
Responses

200

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom 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.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
​
Fees
object
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
ExecutionDate
Unix timestamp
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.
​
Type
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
CreditedWalletId
string
The unique identifier of the credited wallet.
​
DebitedWalletId
string
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.
​
PaymentType
string
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
RedirectURL
string
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.
​
ReturnURL
string
Max. length: 220 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
​
TemplateURL
string
deprecated
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.
​
CardType
string
Returned values: IDEALThe type of card.
​
Culture
string
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.
​
SecureMode
string
Returned values: DEFAULT, FORCE, NO_CHOICEThe 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.
​
Billing
object
Default value: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).Information about the end user billing address. If left empty, the default values will be automatically taken into account.
​
Shipping
object
Default value: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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.
​
BankName
string
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.
{
    "Id": "wt_144da3b7-b6b0-4438-9a7c-75a9695a1816",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1701296081,
    "AuthorId": "204068024",
    "CreditedUserId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 12000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 11000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "204068186",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "WEB",
    "RedirectURL": "https://r3.girogate.de/ti/dumbdummy?tx=140149714181&rs=PyFMwmikCotrnVEf50EQx9jR9Ib38oMG&cs=3d5141c0cf871b4c8a6a53e635a39ebaabbf1e76093fa19bcba331728381b005",
    "ReturnURL": "https://docs.mangopay.com/please-ignore?transactionId=wt_144da3b7-b6b0-4438-9a7c-75a9695a1816",
    "TemplateURL": null,
    "CardType": "IDEAL",
    "Culture": "EN",
    "SecureMode": "DEFAULT",
    "Billing": null,
    "Shipping": null,
    "StatementDescriptor": null,
    "BankName": "Yoursafe"
}  

{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "204068024",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 12000
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 1000
    },
    "CreditedWalletId": "204068186",
    "ReturnURL": "https://docs.mangopay.com/please-ignore",
    "CardType": "IDEAL",
    "Culture": "EN",
    "Bic": "BITSNL2A"
}