Create a Card Deposit Preauthorization

POST

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

POST

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

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/deposit-preauthorizations/card/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
>     "DebitedFunds": {
>       "Currency": "EUR",
>       "Amount": 20000
>     },
>     "CardId": "card_wt_HodULFWKVRMEecCa",
>     "SecureModeReturnURL": "http://example.com",
>     "StatementDescriptor": null,
>     "Culture": "EN",
>     "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
>     },
>     "IpAddress": "4ce4:e138:803f:eb1c:9c5b:7316:ec84:3d00",
>     "Billing": {
>       "FirstName": "Alex",
>       "LastName": "Smith",
>       "Address": {
>         "AddressLine1": "6 rue de la Cité",
>         "AddressLine2": "Appartement 3",
>         "City": "Paris",
>         "Region": "Île-de-France",
>         "PostalCode": "75004",
>         "Country": "FR"
>       }
>     },
>     "Shipping": {
>       "FirstName": "Alex",
>       "LastName": "Smith",
>       "Address": {
>         "AddressLine1": "6 rue de la Cité",
>         "AddressLine2": "Appartement 3",
>         "City": "Paris",
>         "Region": "Île-de-France",
>         "PostalCode": "75004",
>         "Country": "FR"
>       }
>     },
>     "Tag": "Created using Mangopay API Postman Collection"
>   }
> }'

200Successful

1 {
2   "Id": "deposit_wt_073099a9-4e14-42b7-9bc7-d1978f65d8ba",
3   "CreationDate": 1771585135,
4   "ExpirationDate": 1774177135,
5   "AuthorizationDate": null,
6   "AuthorId": "user_m_01KHXAHEBRWSZXJY85TPPR56TK",
7   "DebitedFunds": {
8     "Currency": "EUR",
9     "Amount": 20000
10   },
11   "Status": "CREATED",
12   "PaymentStatus": "WAITING",
13   "PayinsLinked": {
14     "PayinCaptureId": null,
15     "PayinComplementId": null
16   },
17   "ResultCode": null,
18   "ResultMessage": null,
19   "PaymentType": "CARD",
20   "ExecutionType": "DIRECT",
21   "StatementDescriptor": null,
22   "Culture": "EN",
23   "Shipping": {
24     "FirstName": "Alex",
25     "LastName": "Smith",
26     "Address": {
27       "AddressLine1": "6 rue de la Cité",
28       "City": "Paris",
29       "PostalCode": "75004",
30       "Country": "FR",
31       "AddressLine2": "Appartement 3",
32       "Region": "Île-de-France"
33     }
34   },
35   "Tag": "Created using the Mangopay API Postman collection",
36   "CardId": "card_wt_HodULFWKVRMEecCa",
37   "PreferredCardNetwork": null,
38   "SecureModeReturnURL": "http://example.com?depositId=deposit_wt_073099a9-4e14-42b7-9bc7-d1978f65d8ba",
39   "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=073099a9-4e14-42b7-9bc7-d1978f65d8ba&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvMDk5MzBkYzAtZWMwMi00MTlhLTkxZmQtZDdiZjU2M2RjNjNl&amount=MjAwMDA&currency=RVVS",
40   "SecureModeNeeded": true,
41   "BrowserInfo": {
42     "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
43     "JavaEnabled": true,
44     "Language": "FR-FR",
45     "ColorDepth": 4,
46     "ScreenHeight": 1800,
47     "ScreenWidth": 400,
48     "TimeZoneOffset": 60,
49     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
50     "JavascriptEnabled": true
51   },
52   "IpAddress": "4ce4:e138:803f:eb1c:9c5b:7316:ec84:3d00",
53   "Billing": {
54     "FirstName": "Alex",
55     "LastName": "Smith",
56     "Address": {
57       "AddressLine1": "6 rue de la Cité",
58       "AddressLine2": "Appartement 3",
59       "City": "Paris",
60       "Region": "Île-de-France",
61       "PostalCode": "75004",
62       "Country": "FR"
63     }
64   },
65   "Requested3DSVersion": null,
66   "Applied3DSVersion": null,
67   "CardInfo": {
68     "BIN": "497010",
69     "IssuingBank": "LA BANQUE POSTALE",
70     "IssuerCountryCode": "MA",
71     "Type": "CREDIT",
72     "SubType": null,
73     "Brand": "VISA"
74   },
75   "AuthenticationResult": {
76     "AuthenticationType": "CHALLENGE"
77   }
78 }

Create a Card Deposit 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.

PreferredCardNetworkstringOptional

Allowed values: VISA, MASTERCARD, CB, MAESTRO

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

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.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

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

Idstring

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

The unique identifier of the object.

CreationDateinteger

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

ExpirationDateinteger

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

AuthorizationDateinteger

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

AuthorIdstring

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

DebitedFundsobject

Information about the preauthorized funds.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the authorization.

PaymentStatusstring

Returned values: WAITING, CANCELED, CANCEL_REQUESTED, EXPIRED, VALIDATED, FAILED

The payment status of the deposit preauthorization object:

WAITING – The deposit preauthorization can be used: the preauthorized funds can be captured (if Status is SUCCEEDED) or the preauthorization can be canceled manually.
CANCELED – Value to pass to manually cancel the deposit preauthorization before use; indicates that the deposit preauthorization was canceled manually.
CANCEL_REQUESTED – The cancellation of the deposit preauthorization has been requested but not yet processed.
EXPIRED – The hold period on the preauthorized funds has ended without it being used.
VALIDATED – Indicates that the preauthorized funds were captured.
FAILED – The pay-in against the preauthorization has failed, but a retry may be possible.

PayinsLinkedobject

Information about the deposit preauthorized pay-ins made against the deposit preauthorization.

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.

PaymentTypestring

Returned values: CARD

The payment type of the preauthorization.

ExecutionTypestring

Returned values: DIRECT

The execution type of the preauthorization.

StatementDescriptorstring

Max. length: 10 characters; only alphanumeric and spaces

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.

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.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CardIdstring

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

PreferredCardNetworkstring

Allowed values: VISA, MASTERCARD, CB, MAESTRO

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

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.

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.

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.

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