Create a Recurring Card PayIn (CIT or MIT)

POST

/v2.01/:ClientId/payins/recurring/card/direct

POST

/v2.01/:ClientId/payins/recurring/card/direct

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/recurring/card/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "RecurringPayinRegistrationId": "recpayinreg_m_01JJP2KS2A47A0P7S7CEBQPHT9",
>     "IpAddress": "3a55:f45c:d44e:ff6a:c63b:f2ec:3a31:eb3e",
>     "BrowserInfo": {
>       "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
>       "JavaEnabled": true,
>       "Language": "FR-FR",
>       "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
>     },
>     "SecureModeReturnURL": "https://example.com",
>     "StatementDescriptor": "Example123",
>     "Tag": "Created using Mangopay API Postman Collection",
>     "PreferredCardNetwork": "MASTERCARD"
>   }
> }'

1 {
2   "Id": "wt_2da30870-9786-45f5-96fa-8b6442e818e7",
3   "Tag": "Created using Mangopay API Postman Collection",
4   "CreationDate": 1771584873,
5   "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
6   "CreditedUserId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
7   "DebitedFunds": {
8     "Currency": "EUR",
9     "Amount": 10000
10   },
11   "CreditedFunds": {
12     "Currency": "EUR",
13     "Amount": 9000
14   },
15   "Fees": {
16     "Currency": "EUR",
17     "Amount": 1000
18   },
19   "Status": "CREATED",
20   "ResultCode": null,
21   "ResultMessage": null,
22   "ExecutionDate": null,
23   "Type": "PAYIN",
24   "Nature": "REGULAR",
25   "CreditedWalletId": "wlt_m_01KHXAHH2NA3AAMPGE1SJPHJDJ",
26   "DebitedWalletId": null,
27   "PaymentType": "CARD",
28   "ExecutionType": "DIRECT",
29   "SecureMode": "DEFAULT",
30   "CardId": "card_wt_HodULFWKVRMEecCa",
31   "SecureModeReturnURL": "http://example.com?transactionId=wt_2da30870-9786-45f5-96fa-8b6442e818e7",
32   "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=2da30870-9786-45f5-96fa-8b6442e818e7&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvMWZmYjIyNGUtMjcxNi00NzNmLTg2ZDctOWQxZGU2NjE0MTE4&amount=MTAwMDA&currency=RVVS",
33   "SecureModeNeeded": true,
34   "Culture": "EN",
35   "SecurityInfo": {
36     "AVSResult": "NO_CHECK"
37   },
38   "StatementDescriptor": "Example123",
39   "BrowserInfo": {
40     "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
41     "JavaEnabled": true,
42     "Language": "FR-FR",
43     "ColorDepth": 4,
44     "ScreenHeight": 1800,
45     "ScreenWidth": 400,
46     "TimeZoneOffset": 60,
47     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
48     "JavascriptEnabled": true
49   },
50   "IpAddress": "0dfa:4248:0148:b497:65f4:98aa:8e69:13e6",
51   "Billing": {
52     "FirstName": "Alex",
53     "LastName": "Smith",
54     "Address": {
55       "AddressLine1": "6 rue de la Cité",
56       "AddressLine2": "Appartement 3",
57       "City": "Paris",
58       "Region": "île-de-France",
59       "PostalCode": "75003",
60       "Country": "FR"
61     }
62   },
63   "Shipping": {
64     "FirstName": "Alex",
65     "LastName": "Smith",
66     "Address": {
67       "AddressLine1": "6 rue de la Cité",
68       "City": "Paris",
69       "PostalCode": "75003",
70       "Country": "FR",
71       "AddressLine2": "Appartement 3",
72       "Region": "île-de-France"
73     }
74   },
75   "Requested3DSVersion": null,
76   "Applied3DSVersion": null,
77   "PreferredCardNetwork": null,
78   "PaymentCategory": "ECommerce",
79   "CardInfo": {
80     "BIN": "497010",
81     "IssuingBank": "LA BANQUE POSTALE",
82     "IssuerCountryCode": "MA",
83     "Type": "CREDIT",
84     "SubType": null,
85     "Brand": "VISA"
86   },
87   "AuthenticationResult": {
88     "AuthenticationType": "CHALLENGE"
89   },
90   "RecurringPayinRegistrationId": "recpayinreg_wt_0995a657-85ea-4860-9177-317b2227e2c7"
91 }

Request a recurring card pay-in based on a RecurringPayinRegistrationId with PaymentType CARD, obtained from POST Create a Recurring PayIn Registration.

There are two possible paylods:

CIT – Customer-initiated transaction when the user is on session, requiring them to authenticate on the SecureModeRedirectURL returned.
MIT – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required.

Request a recurring card pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `CARD`, obtained from [POST Create a Recurring PayIn Registration](/api-reference/recurring-payin-registrations/create-recurring-payin-registration). There are two possible paylods: - **CIT** – Customer-initiated transaction when the user is on session, requiring them to authenticate on the `SecureModeRedirectURL` returned. - **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required.

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.

Card CITobjectRequired

Request body for a card customer-initiated transcation (CIT).

Card MITobjectRequired

Request body for a card merchant-initiated transaction (MIT).

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: DIRECT

The execution type of the pay-in.

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.

CardIdstring

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

SecureModeReturnURLstring

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

SecureModeRedirectURLstring

Max. length: 255 characters

The URL to which to redirect the user to proceed to 3DS2 validation.

SecureModeNeededboolean

Whether or not the SecureMode was used.

Culturestring

Returned values: One of the supported languages in the ISO 639-1 format: DE, EN, ES, FR, IT, NL, PL, PT.

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

SecurityInfoobject

Information regarding security and anti-fraud tools.

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.

BrowserInfoobject

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

IpAddressstring

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

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.

Requested3DSVersionstring

Returned values: V1, V2_1

The 3DS protocol version to be applied to the transaction.

Applied3DSVersionstring

Returned values: V1, V2_1

The 3DS protocol version applied to the transaction.

PreferredCardNetworkstring

Allowed values: VISA, MASTERCARD, CB, MAESTRO

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

PaymentCategorystring

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

CardInfoobject

Information about the card used for the transaction. If the information or data is not available, null is returned.

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

RecurringPayinRegistrationIdstring

The unique identifier of the recurring pay-in registration.

Errors

400

Bad Request Error