Create a Preauthorization

POST

/v2.01/:ClientId/preauthorizations/card/direct

POST

/v2.01/:ClientId/preauthorizations/card/direct

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/preauthorizations/card/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
>     "Billing": {
>       "Address": {
>         "AddressLine1": "6 rue de la Cité",
>         "AddressLine2": "Appartement 3",
>         "City": "Paris",
>         "Country": "FR",
>         "PostalCode": "75001",
>         "Region": "Ile-de-France"
>       },
>       "FirstName": "Alex",
>       "LastName": "Smith"
>     },
>     "BrowserInfo": {
>       "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
>       "ColorDepth": 4,
>       "JavaEnabled": true,
>       "JavascriptEnabled": true,
>       "Language": "FR-FR",
>       "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"
>     },
>     "CardId": "card_wt_kLbkQOJbzUhMZmxG",
>     "Culture": "EN",
>     "DebitedFunds": {
>       "Amount": 10000,
>       "Currency": "EUR"
>     },
>     "FlowDescriptor": {
>       "Beneficiaries": [
>         {
>           "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
>         }
>       ]
>     },
>     "IpAddress": "854f:1b03:7d1b:bfbf:e1f0:b1f3:3810:c5ac",
>     "SecureModeReturnURL": "http://example.com",
>     "Shipping": {
>       "Address": {
>         "AddressLine1": "6 rue de la Cité",
>         "AddressLine2": "Appartement 3",
>         "City": "Paris",
>         "Country": "FR",
>         "PostalCode": "75001",
>         "Region": "Ile-de-France"
>       },
>       "FirstName": "Alex",
>       "LastName": "Smith"
>     },
>     "StatementDescriptor": "Example123",
>     "Tag": "Created using Mangopay API Postman Collection"
>   }
> }'

200Successful

1 {
2   "Id": "preauth_wt_064022a9-3640-4ed1-a4bd-3488426428fa",
3   "Tag": null,
4   "CreationDate": 1771580609,
5   "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
6   "FlowDescriptor": {
7     "FlowId": "flow_wt_97448e0a-5bc6-4b83-ac29-cdfcadf60a08",
8     "Beneficiaries": [
9       {
10         "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
11       }
12     ]
13   },
14   "DebitedFunds": {
15     "Currency": "EUR",
16     "Amount": 10000
17   },
18   "RemainingFunds": {
19     "Currency": "EUR",
20     "Amount": 10000
21   },
22   "AuthorizationDate": null,
23   "Status": "CREATED",
24   "PaymentStatus": "WAITING",
25   "ExpirationDate": null,
26   "PayInId": null,
27   "ResultCode": null,
28   "ResultMessage": null,
29   "SecureMode": "DEFAULT",
30   "CardId": "card_wt_kLbkQOJbzUhMZmxG",
31   "SecureModeReturnURL": "http://example.com?preAuthorizationId=preauth_wt_064022a9-3640-4ed1-a4bd-3488426428fa",
32   "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=064022a9-3640-4ed1-a4bd-3488426428fa&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvOTE2YWE5M2YtMDI4MS00ZjVlLTg5MWUtNmUwZGJkMmU3YTEz&amount=MTAwMDA&currency=RVVS",
33   "SecureModeNeeded": true,
34   "PaymentType": "CARD",
35   "ExecutionType": "DIRECT",
36   "StatementDescriptor": null,
37   "Culture": "EN",
38   "SecurityInfo": {
39     "AVSResult": "NO_CHECK"
40   },
41   "MultiCapture": true,
42   "BrowserInfo": {
43     "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
44     "JavaEnabled": true,
45     "Language": "FR-FR",
46     "ColorDepth": 4,
47     "ScreenHeight": 1800,
48     "ScreenWidth": 400,
49     "TimeZoneOffset": 60,
50     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
51     "JavascriptEnabled": true
52   },
53   "IpAddress": "854f:1b03:7d1b:bfbf:e1f0:b1f3:3810:c5ac",
54   "Billing": {
55     "FirstName": "Alex",
56     "LastName": "Smith",
57     "Address": {
58       "AddressLine1": "6 rue de la Cité",
59       "AddressLine2": "Appartement 3",
60       "City": "Paris",
61       "Region": "Ile-de-France",
62       "PostalCode": "75001",
63       "Country": "FR"
64     }
65   },
66   "Shipping": {
67     "FirstName": "Alex",
68     "LastName": "Smith",
69     "Address": {
70       "AddressLine1": "6 rue de la Cité",
71       "City": "Paris",
72       "PostalCode": "75001",
73       "Country": "FR",
74       "AddressLine2": "Appartement 3",
75       "Region": "Ile-de-France"
76     }
77   },
78   "Requested3DSVersion": null,
79   "Applied3DSVersion": null,
80   "PreferredCardNetwork": null,
81   "PaymentCategory": "ECommerce",
82   "CardInfo": {
83     "BIN": "497010",
84     "IssuingBank": "LA BANQUE POSTALE",
85     "IssuerCountryCode": "MA",
86     "Type": "CREDIT",
87     "SubType": null,
88     "Brand": "VISA"
89   },
90   "AuthenticationResult": {
91     "AuthenticationType": "CHALLENGE"
92   }
93 }

Create a Preauthorization

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 preauthorized funds.

CardIdstringRequired

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

SecureModeReturnURLstringRequired

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

BrowserInfoobjectRequired

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

IpAddressstringRequired

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

FlowDescriptorobjectOptional

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
ALL UserId values in the array must be one of:
- OWNER whose KYCLevel is REGULAR
- PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

PAYER
OWNER whose KYCLevel is LIGHT

If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

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.

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.

CulturestringOptional

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

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.

PreferredCardNetworkstringOptional

Allowed values: VISA, MASTERCARD, CB, MAESTRO

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

PaymentCategorystringOptional

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

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.

Response

Success

IdstringOptional

Max. length: 255 characters

The unique identifier of the preauthorization.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateintegerOptional

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

AuthorIdstringOptional

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

FlowDescriptorobjectOptional

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
ALL UserId values in the array must be one of:
- OWNER whose KYCLevel is REGULAR
- PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

PAYER
OWNER whose KYCLevel is LIGHT

DebitedFundsobjectOptional

Information about the preauthorized funds.

RemainingFundsobjectOptional

Information about the remaining preauthorized funds.

AuthorizationDateintegerOptional

Unix timestamp (UTC) of the date and time successful authorization occurred. If authorization failed, the value is null.

StatusstringOptional

Returned values: CREATED, SUCCEEDED, FAILED

The status of the authorization.

PaymentStatusstringOptional

Returned values: WAITING, CANCELED, EXPIRED, VALIDATED

The status of the preauthorization object:

WAITING – The remaining preauthorized funds can be captured by making one or several preauthorized pay-ins. Pay-ins can only be made against a preauthorization with the WAITING status.
CANCELED – The preauthorization was canceled manually before any preauthorized pay-ins were made, or it was canceled automatically because the authorization failed.
EXPIRED – The hold period on the preauthorized funds has ended without any preauthorized pay-ins taking place.
VALIDATED – During the hold period: Indicates that all the preauthorized funds have been captured (RemainingFunds is zero) and no more preauthorized pay-ins can be made. After the hold period: Indicates that at least one capture was made during the hold period.

ExpirationDateintegerOptional

Unix timestamp (UTC) of the date and time the hold period ends and the preauthorized funds are released. At the expiration date, the preauthorization’s PaymentStatus changes to EXPIRED if no captures were made or VALIDATED if at least one capture was made.

PayInIdstringOptional

The unique identifier of the pay-in.

ResultCodestringOptional

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

ResultMessagestringOptional

The explanation of the result code.

SecureModestringOptional

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.

CardIdstringOptional

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

SecureModeReturnURLstringOptional

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

SecureModeRedirectURLstringOptional

Max. length: 255 characters

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

SecureModeNeededbooleanOptional

Whether or not the SecureMode was used.

PaymentTypestringOptional

Returned values: CARD

The payment type of the preauthorization.

ExecutionTypestringOptional

Returned values: DIRECT

The execution type of the preauthorization.

StatementDescriptorstringOptional

Max. length: 10 characters; only alphanumeric and spaces

CulturestringOptional

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.

SecurityInfoobjectOptional

Information regarding security and anti-fraud tools.

MultiCapturebooleanOptional

Default value: true

Whether multiple captures are activated for the preauthorization.

BrowserInfoobjectOptional

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

IpAddressstringOptional

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

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.

Requested3DSVersionstringOptional

Returned values: V1, V2_1

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

Applied3DSVersionstringOptional

Returned values: V1, V2_1

The 3DS protocol version applied to the transaction.

PreferredCardNetworkstringOptional

Allowed values: VISA, MASTERCARD, CB, MAESTRO

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

PaymentCategorystringOptional

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

CardInfoobjectOptional

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

AuthenticationResultobjectOptional

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