Create a Web Card PayIn

POST

/v2.01/:ClientId/payins/card/web

POST

/v2.01/:ClientId/payins/card/web

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/card/web \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "Tag": "Created using the Mangopay API Postman collection",
>     "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
>     "DebitedFunds": {
>       "Currency": "EUR",
>       "Amount": 2000
>     },
>     "Fees": {
>       "Currency": "EUR",
>       "Amount": 100
>     },
>     "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
>     "ReturnURL": "http://www.example.com",
>     "Culture": "EN",
>     "SecureMode": "DEFAULT",
>     "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"
>       }
>     },
>     "StatementDescriptor": "Example123",
>     "CardType": "CB_VISA_MASTERCARD"
>   }
> }'

200webCardPayins

1 {
2   "Id": "wt_f0f67b58-2856-469c-952c-b06e556a70e6",
3   "Tag": "Created using the Mangopay API Postman collection",
4   "CreationDate": 1746006308,
5   "AuthorId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
6   "CreditedUserId": "user_m_01JHQRCND66XP99SVBXQRP54MF",
7   "DebitedFunds": {
8     "Currency": "EUR",
9     "Amount": 2000
10   },
11   "CreditedFunds": {
12     "Currency": "EUR",
13     "Amount": 1900
14   },
15   "Fees": {
16     "Currency": "EUR",
17     "Amount": 100
18   },
19   "Status": "CREATED",
20   "ResultCode": null,
21   "ResultMessage": null,
22   "ExecutionDate": null,
23   "Type": "PAYIN",
24   "Nature": "REGULAR",
25   "CreditedWalletId": "wlt_m_01JHQRD0WZ1QWKNAMQF93E5M15",
26   "DebitedWalletId": null,
27   "PaymentType": "CARD",
28   "ExecutionType": "WEB",
29   "RedirectURL": "https://pay.mangopay.com?id=wt_f0f67b58-2856-469c-952c-b06e556a70e6&client-token=hpp_f5d3a2c1b8e045f7a9d6c3b2a1e9d8c7",
30   "ReturnURL": "http://example.com&transactionId=wt_f0f67b58-2856-469c-952c-b06e556a70e6",
31   "TemplateURL": null,
32   "CardType": "CB_VISA_MASTERCARD",
33   "Culture": "EN",
34   "SecureMode": "DEFAULT",
35   "Billing": {
36     "FirstName": "Alex",
37     "LastName": "Smith",
38     "Address": {
39       "AddressLine1": "6 rue de la Cité",
40       "AddressLine2": "Appartement 3",
41       "City": "Paris",
42       "Region": "Île-de-France",
43       "PostalCode": "75001",
44       "Country": "FR"
45     }
46   },
47   "Shipping": {
48     "FirstName": "Alex",
49     "LastName": "Smith",
50     "Address": {
51       "AddressLine1": "6 rue de la Cité",
52       "City": "Paris",
53       "PostalCode": "75001",
54       "Country": "FR",
55       "AddressLine2": "Appartement 3",
56       "Region": "Île-de-France"
57     }
58   },
59   "StatementDescriptor": "Example123",
60   "BankName": null,
61   "AuthenticationResult": {
62     "AuthenticationType": "FRICTIONLESS"
63   }
64 }

Note – Timeout after 15 minutes

The hosted payment page session on the RedirectURL lasts 15 minutes, at which point the pay-in fails automatically with result code 101109 if it is not completed by the user.

Caution – TemplateURL customization feature deprecated

The TemplateURL response parameter is deprecated and must no longer be used to redirect the user. You must redirect the user on the RedirectURL.

The TemplateURLOptions body parameter is also deprecated as the feature allowing minor customization of the hosted page is no longer supported.

Note: The legacy iDEAL integration also uses this endpoint with CardType set to IDEAL. New integrations of iDEAL should use the Create an iDEAL PayIn endpoint.

<Note icon="fa-regular fa-circle-info"> **Note – Timeout after 15 minutes** The hosted payment page session on the `RedirectURL` lasts 15 minutes, at which point the pay-in fails automatically with result code [101109](/errors/codes/101109) if it is not completed by the user. </Note> <Warning icon="fa-regular fa-triangle-exclamation"> **Caution – TemplateURL customization feature deprecated** The `TemplateURL` response parameter is deprecated and must no longer be used to redirect the user. You must redirect the user on the `RedirectURL`. The `TemplateURLOptions` body parameter is also deprecated as the feature allowing minor customization of the hosted page is no longer supported. </Warning> [Read more about the Web Card PayIn object →](/api-reference/web-card-payins/web-card-payin-object) **Note:** The legacy iDEAL integration also uses this endpoint with `CardType` set to `IDEAL`. New integrations of iDEAL should use the <a href="/api-reference/ideal/create-ideal-payin">Create an iDEAL PayIn</a> endpoint.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

AuthorIdstringRequired

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

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

ReturnURLstringRequired

Max length: 220 characters. The URL to which the user is returned after the payment, whether the transaction is successful or not.

CardTypestringRequired

Allowed values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMC. The type of the card.

CulturestringRequired

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.

TagstringOptional

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.

CreditedUserIdstringOptional

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

The unique identifier of the user whose wallet is credited.

TemplateURLOptionsobjectOptional

Caution: This customization feature is deprecated and must no longer be used. The URL of the SSL page of your customized payment page.

SecureModestringOptional

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.

BillingobjectOptional

Default values: FirstName, LastName, and Address information of the Shipping object if sent, otherwise of the AuthorId (if address values present).

Information about the billing address.

ShippingobjectOptional

Default values: FirstName, LastName, and Address information of the Billing object if sent, otherwise of the AuthorId (if address values present).

Information about the shipping address.

StatementDescriptorstringOptional

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.

ProfilingAttemptReferencestringOptional

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.

Bicstring or nullOptionalDeprecated

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

This field was used by legacy iDEAL integrations and is still accepted by the API for backwards compatibility. New integrations should use the dedicated Create an iDEAL PayIn endpoint instead.

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

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

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

AuthorIdstring

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

CreditedUserIdstring

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

The unique identifier of the user whose wallet is credited.

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Feesobject

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

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.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

DebitedWalletIdstring

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.

PaymentTypestring

Returned values: CARD

The payment type of the pay-in.

ExecutionTypestring

Returned values: WEB

The execution type of the pay-in.

RedirectURLstring

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.

ReturnURLstring

Max. length: 220 characters

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

TemplateURLstring

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.

CardTypestring

Returned values: CB_VISA_MASTERCARD, AMEX, MAESTRO, BCMC

The type of the card.

Culturestring

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.

SecureModestring

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.

Billingobject

Default values: FirstName, LastName, and Address information of the Shipping object if sent, otherwise of the AuthorId (if address values present).

Information about the billing address.

Shippingobject

Default values: FirstName, LastName, and Address information of the Billing object if sent, otherwise of the AuthorId (if address values present).

Information about the shipping address.

StatementDescriptorstring

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.

BankNamestring

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 Create a Web Card PayIn (iDEAL) for more information.

AuthenticationResultobject

Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable).