Skip to main content
POST
/
v2.01
/
{ClientId}
/
deposit-preauthorizations
/
card
/
direct
{
    "AuthorId": "203063430",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 20000
    },
    "CardId": "203076791",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore",
    "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": "97d6:24d6:357a:8acc:5190:606b:91a2:f60c",
    "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"
}  

{
   "Id": "524a7e9c-cad9-4df7-9fe3-03b8948930fe",
   "CreationDate": 1669137219,
   "ExpirationDate": 1671729219,
   "AuthorId": "156671912",
   "DebitedFunds": {
       "Currency": "EUR",
       "Amount": 500
   },
   "Status": "CREATED",
   "PaymentStatus": "WAITING",
   "PayinsLinked": {
       "PayinCaptureId": null,
       "PayinComplementId": null
   },
   "ResultCode": null,
   "ResultMessage": null,
   "CardId": "156674899",
   "PreferredCardNetwork": null,
   "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore?depositId=524a7e9c-cad9-4df7-9fe3-03b8948930fe",
   "SecureModeRedirectURL": "https://api.sandbox.mangopay.com/deposit-preauthorizations/Acs/Redirect?secureSessionToken=8bf75b26-01c1-4745-8f82-727e8a047dcb",
   "SecureModeNeeded": true,
   "PaymentType": "CARD",
   "ExecutionType": "DIRECT",
   "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": "80.236.38.245",
   "Billing": {
       "FirstName": "Joe",
       "LastName": "Bloggs",
       "Address": {
           "AddressLine1": null,
           "AddressLine2": null,
           "City": null,
           "Region": null,
           "PostalCode": null,
           "Country": null
       }
   },
   "Shipping": {
       "FirstName": "Joe",
       "LastName": "Bloggs",
       "Address": {
           "AddressLine1": null,
           "AddressLine2": null,
           "City": null,
           "Region": null,
           "PostalCode": null,
           "Country": null
       }
   },
   "Requested3DSVersion": null,
   "Applied3DSVersion": "V2_1",
   "Tag": "Custom meta",
   "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "Brand": "VISA",
        "SubType": null
    }
}

​
Body parameters

​
AuthorId
string
required
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
required
Information about the preauthorized funds.
​
CardId
string
required
The unique identifier of the Card object, obtained during the card registration process.
​
PreferredCardNetwork
string
Allowed values: VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.
​
SecureModeReturnURL
string
required
Max. length: 255 charactersThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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.
​
Culture
string
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.
​
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.
​
Tag
string
Max. length: 255 charactersCustom 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.
​
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
string
Max. length: 255 characters
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
ExpirationDate
Unix timestamp
The date and time at which 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.
​
AuthorId
string
The unique identifier of the user at the source of the transaction.
​
DebitedFunds
object
Information about the preauthorized funds.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the authorization.
​
PaymentStatus
string
Returned values: WAITING, CANCELED, CANCEL_REQUESTED, EXPIRED, VALIDATED, FAILEDThe payment status of the deposit preauthorization object:
  • WAITING – The deposit preauthorization can be used: the preauthorized funds can be captured 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.
​
PayinsLinked
object
Information about the deposit preauthorized pay-ins made against the deposit preauthorization.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
CardId
string
The unique identifier of the Card object, obtained during the card registration process.
​
PreferredCardNetwork
string
Returned values: VISA, MASTERCARD, CB, MAESTROThe card network to use, as chosen by the cardholder, in case of co-branded cards.
​
SecureModeReturnURL
string
Max. length: 255 charactersThe URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).
​
SecureModeRedirectURL
string
Max. length: 255 charactersThe URL to which to redirect the user to proceed to 3DS2 validation.
​
SecureModeNeeded
boolean
Whether or not the SecureMode was used.
​
PaymentType
string
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
StatementDescriptor
string
Max. length: 10 characters; only alphanumeric and spacesCustom 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.
​
Culture
string
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.
​
BrowserInfo
object
Information about the browser used by the end user (author) to perform the payment.
​
IpAddress
string
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.
​
Requested3DSVersion
string
Returned values: V1, V2_1The 3DS protocol version to be applied to the transaction.
​
Applied3DSVersion
string
Returned values: V1, V2_1The 3DS protocol version applied to the transaction.
​
Tag
string
Max. length: 255 charactersCustom 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.
​
CardInfo
string
Information about the card used for the transaction.If the information or data is not available, null is returned.
{
   "Id": "524a7e9c-cad9-4df7-9fe3-03b8948930fe",
   "CreationDate": 1669137219,
   "ExpirationDate": 1671729219,
   "AuthorId": "156671912",
   "DebitedFunds": {
       "Currency": "EUR",
       "Amount": 500
   },
   "Status": "CREATED",
   "PaymentStatus": "WAITING",
   "PayinsLinked": {
       "PayinCaptureId": null,
       "PayinComplementId": null
   },
   "ResultCode": null,
   "ResultMessage": null,
   "CardId": "156674899",
   "PreferredCardNetwork": null,
   "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore?depositId=524a7e9c-cad9-4df7-9fe3-03b8948930fe",
   "SecureModeRedirectURL": "https://api.sandbox.mangopay.com/deposit-preauthorizations/Acs/Redirect?secureSessionToken=8bf75b26-01c1-4745-8f82-727e8a047dcb",
   "SecureModeNeeded": true,
   "PaymentType": "CARD",
   "ExecutionType": "DIRECT",
   "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": "80.236.38.245",
   "Billing": {
       "FirstName": "Joe",
       "LastName": "Bloggs",
       "Address": {
           "AddressLine1": null,
           "AddressLine2": null,
           "City": null,
           "Region": null,
           "PostalCode": null,
           "Country": null
       }
   },
   "Shipping": {
       "FirstName": "Joe",
       "LastName": "Bloggs",
       "Address": {
           "AddressLine1": null,
           "AddressLine2": null,
           "City": null,
           "Region": null,
           "PostalCode": null,
           "Country": null
       }
   },
   "Requested3DSVersion": null,
   "Applied3DSVersion": "V2_1",
   "Tag": "Custom meta",
   "CardInfo": {
        "BIN": "497010",
        "IssuingBank": "LA BANQUE POSTALE",
        "IssuerCountryCode": "MA",
        "Type": "CREDIT",
        "Brand": "VISA",
        "SubType": null
    }
}  

{
    "AuthorId": "203063430",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 20000
    },
    "CardId": "203076791",
    "SecureModeReturnURL": "https://docs.mangopay.com/please-ignore",
    "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": "97d6:24d6:357a:8acc:5190:606b:91a2:f60c",
    "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"
}