POST
/
v2.01
/
{ClientId}
/
payins
/
card
/
direct
{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 57842
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 8877
    },
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "SecureMode": "DEFAULT",
    "CardId": "card_m_iWdaSvYItChPyoia",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore",
    "StatementDescriptor": "Mangopay",
    "BrowserInfo": {
        "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
        "JavaEnabled": true,
        "Language": "en",
        "ColorDepth": 4,
        "ScreenHeight": 1800,
        "ScreenWidth": 400,
        "TimeZoneOffset": 60,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "IpAddress": "658e:1b88:7f7a:a60b:32af:0b7f:56e1:2e9a",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    }
}  

{
    "Id": "wt_ba1e1201-ef12-4c33-942d-8461f1686a67",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1700210889,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 57842
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 48965
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 8877
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "DIRECT",
    "SecureMode": "DEFAULT",
    "CardId": "card_m_iWdaSvYItChPyoia",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore?transactionId=209160523",
    "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=d7a9a1dd-80aa-4252-b2b4-221e1898d67f&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvYzA1YTBhYzktNjBmZC00NDQyLWEzYzAtYjlmOTVlN2I1ODk5&amount=MzMzNDE&currency=RVVS",
    "SecureModeNeeded": true,
    "Culture": "EN",
    "SecurityInfo": {
        "AVSResult": "NO_CHECK"
    },
    "StatementDescriptor": "Mangopay",
    "BrowserInfo": {
        "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
        "JavaEnabled": true,
        "Language": "en",
        "ColorDepth": 4,
        "ScreenHeight": 1800,
        "ScreenWidth": 400,
        "TimeZoneOffset": 60,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "IpAddress": "658e:1b88:7f7a:a60b:32af:0b7f:56e1:2e9a",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Requested3DSVersion": null,
    "Applied3DSVersion": "V2_1",
    "RecurringPayinRegistrationId": null,
    "PreferredCardNetwork": null,
    "PaymentCategory": "ECommerce",
    "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "Brand": "VISA",
        "SubType": null
    }
}

Read more about the Direct Card PayIn object →

​
Body parameters

​
Tag
string

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.

​
AuthorId
string
required

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
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).

​
CreditedWalletId
string
required

The unique identifier of the credited wallet.

​
SecureMode
string

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.
​
CardId
string
required

The unique identifier of the Card object, obtained during the card registration process.

​
SecureModeReturnURL
string
required

Max. length: 255 characters

The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).

​
Culture
string
deprecated

The language in which the payment page is to be displayed. This deprecated parameter defaults to EN.

​
StatementDescriptor
string

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.

​
BrowserInfo
object
required

Information about the browser used by the end user (author) to perform the payment.

​
IpAddress
string
required

The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.

​
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.

​
PreferredCardNetwork
string

Allowed values: VISA, MASTERCARD, CB, MAESTRO

The card network to use, as chosen by the cardholder, in case of co-branded cards.

​
PaymentCategory
string

Default value: ECommerce

Allowed values: ECommerce, TelephoneOrder

The channel through which the user provided their card details, used to indicate mail-order and telephone-order (MOTO) payments:

  • ECommerce – Payment received online.
  • TelephoneOrder – Payment received via mail order or telephone order (MOTO).
​
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.

​
Responses

{
    "Id": "wt_ba1e1201-ef12-4c33-942d-8461f1686a67",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1700210889,
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 57842
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 48965
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 8877
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "DebitedWalletId": null,
    "PaymentType": "CARD",
    "ExecutionType": "DIRECT",
    "SecureMode": "DEFAULT",
    "CardId": "card_m_iWdaSvYItChPyoia",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore?transactionId=209160523",
    "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=d7a9a1dd-80aa-4252-b2b4-221e1898d67f&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvYzA1YTBhYzktNjBmZC00NDQyLWEzYzAtYjlmOTVlN2I1ODk5&amount=MzMzNDE&currency=RVVS",
    "SecureModeNeeded": true,
    "Culture": "EN",
    "SecurityInfo": {
        "AVSResult": "NO_CHECK"
    },
    "StatementDescriptor": "Mangopay",
    "BrowserInfo": {
        "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
        "JavaEnabled": true,
        "Language": "en",
        "ColorDepth": 4,
        "ScreenHeight": 1800,
        "ScreenWidth": 400,
        "TimeZoneOffset": 60,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "IpAddress": "658e:1b88:7f7a:a60b:32af:0b7f:56e1:2e9a",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Requested3DSVersion": null,
    "Applied3DSVersion": "V2_1",
    "RecurringPayinRegistrationId": null,
    "PreferredCardNetwork": null,
    "PaymentCategory": "ECommerce",
    "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "Brand": "VISA",
        "SubType": null
    }
}  

{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 57842
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 8877
    },
    "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
    "SecureMode": "DEFAULT",
    "CardId": "card_m_iWdaSvYItChPyoia",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore",
    "StatementDescriptor": "Mangopay",
    "BrowserInfo": {
        "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
        "JavaEnabled": true,
        "Language": "en",
        "ColorDepth": 4,
        "ScreenHeight": 1800,
        "ScreenWidth": 400,
        "TimeZoneOffset": 60,
        "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
        "JavascriptEnabled": true
    },
    "IpAddress": "658e:1b88:7f7a:a60b:32af:0b7f:56e1:2e9a",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "Île-de-France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    }
}