View a Deposit Preauthorization

Path parameters

DepositId · string · required

The unique identifier of the deposit preauthorization.

Responses

200 - Response parameters

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.

AuthorizationDate · Unix timestamp

The date and time at which successful authorization occurred. If authorization failed, the value is null.

AuthorId · string

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

DebitedFunds · object

Information about the preauthorized funds.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the preauthorized funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the authorization.

PaymentStatus · string

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

Show child attributes

PayinCaptureId · string

The unique identifier of the preauthorized pay-in (capture) made against the deposit preauthorization to debit the preauthorized funds.

PayinComplementId · string

The unique identifier of the deposit preauthorized pay-in complement made against the deposit preauthorization to debit additional funds.

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, MAESTRO

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

SecureModeReturnURL · string

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

SecureModeRedirectURL · string

Max. length: 255 characters

The 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_WIRE

The type of pay-in.

ExecutionType · string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

StatementDescriptor · string

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.

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.

Show properties

AcceptHeader · string

The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.

JavaEnabled · boolean

Whether or not the end user’s browser has the ability to execute Java.

Language · string

Format: Two-letter language code (ISO 639-1 alpha-2) followed by two-letter country code (ISO 3166-1 alpha-2), separated by a hyphen (example: en-US; pattern:^[a-zA-Z]{2}(-[a-zA-Z]{2})?$)

The language of the browser.

ColorDepth · integer

The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.

ScreenHeight · integer

Max. length: 6 characters

The height of the screen in pixels.

ScreenWidth · integer

Max. length: 6 characters

The width of the screen in pixels.

TimeZoneOffset · integer

The difference in minutes between the browser’s timezone and UTC.

UserAgent · string

Max. length: 255 characters

The exact content of the HTTP User-Agent header.

JavascriptEnabled · boolean

Whether or not the end user’s browser has the ability to execute JavaScript.

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.

Show properties

FirstName · string

The first name of the user.

LastName · string

Max. length: 100 characters

The last name of the user.

Address · object

Information about the billing address.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

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.

Show properties

FirstName · string

The first name of the user.

LastName · string

Max. length: 100 characters

The last name of the user.

Address · object

Information about the shipping address.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

Requested3DSVersion · string

Returned values: V1, V2_1

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

Applied3DSVersion · string

Returned values: V1, V2_1

The 3DS protocol version applied to the transaction.

Tag · string

Max. length: 255 characters

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.

CardInfo · string

Information about the card used for the transaction.

If the information or data is not available, null is returned.

Show properties

BIN · string

The 6-digit bank identification number (BIN) of the card issuer.

IssuingBank · string

The name of the card issuer.

IssuerCountryCode · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country where the card was issued.

Type · string

Returned values: DEBIT, CREDIT, CHARGE CARD.

The type of card product.

Brand · string

The card brand. Examples include: AMERICAN EXPRESS, DISCOVER, JCB, MASTERCARD, VISA, etc.

Note: The possible returned values are numerous and liable to evolve over time.

SubType · string

The subtype of the card product. Examples include: CLASSIC, GOLD, PLATINUM, PREPAID, etc.

Note: The possible returned values are numerous and liable to evolve over time.

200 - Capture

{
   "Id": "524a7e9c-cad9-4df7-9fe3-03b8948930fe",
   "CreationDate": 1669137219,
   "ExpirationDate": 1671729219,
   "AuthorizationDate": 1669137235,
   "AuthorId": "156671912",
   "DebitedFunds": {
       "Currency": "EUR",
       "Amount": 1000
   },
   "Status": "SUCCEEDED",
   "PaymentStatus": "VALIDATED",
   "PayinsLinked": {
       "PayinCaptureId": "1719d157-5a97-4af3-91b0-7d660b34b21c",
       "PayinComplementId": null
   },
   "ResultCode": "000000",
   "ResultMessage": "Success",
   "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
    }
}  

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
  $depositId = 'deposit_m_01JH3BWB8K89TDQC54FFZY6MFV';

  $response = $api->Deposits->Get($depositId);

  print_r($response);
} catch(MGPResponseException $e) {
  print_r($e);
} catch(MGPException $e) {
  print_r($e);
}