Path parameters
The unique identifier of the user.
Responses
200
200
The list of preauthorizations created by the platform.
Show properties
Show properties
The preauthorization created by the platform.
Show properties
Show properties
Max. length: 255 charactersThe unique identifier of the preauthorization.
Max. length: 255 charactersCustom data that you can add to this object.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.
For preauthorizations, you can use this parameter to identify corresponding information regarding the user or transaction on your platform.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author.
Information about the preauthorized funds.
Show properties
Show properties
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.
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
).Information about the remaining preauthorized funds.
Show properties
Show properties
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.
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
).The date and time at which successful authorization occurred. If authorization failed, the value is
null
.Returned values:
CREATED
, SUCCEEDED
, FAILED
The status of the authorization.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.
The date and time at which the hold period ends and the preauthorized funds are released.
At the expiration date, the preauthorization’s
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.The unique identifier of the first preauthorized pay-in made against the preauthorization.
The explanation of the result code.
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.
The unique identifier of the Card object, which is returned after updating the Card Registration object with the
RegistrationData
.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
).Whether or not the
SecureMode
was used.Returned values:
APPLEPAY
The type of pay-in.Returned values:
WEB
, DIRECT
, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.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.
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.
Information regarding security and anti-fraud tools.
Show properties
Show properties
The result of the Address Verification System check (only available for UK, US, and Canada).
Default value: trueWhether multiple captures are activated for the preauthorization.
Information about the browser used by the end user (author) to perform the payment.
Show properties
Show properties
The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.
Whether or not the end user’s browser has the ability to execute Java.
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.The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.
Max. length: 6 charactersThe height of the screen in pixels.
Max. length: 6 charactersThe width of the screen in pixels.
The difference in minutes between the browser’s timezone and UTC.
Max. length: 255 charactersThe exact content of the HTTP User-Agent header.
Whether or not the end user’s browser has the ability to execute JavaScript.
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
Show properties
The first name of the user.
Max. length: 100 charactersThe last name of the user.
Information about the billing address.
Show properties
Show properties
Max. length: 255 charactersThe first line of the address.
Max. length: 255 charactersThe second line of the address.
Max. length: 255 charactersThe city of the address.
Max. length: 255 charactersThe region of the address. This field is optional except if the
Country
is US, CA, or MX.Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.
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
Show properties
The first name of the user.
Max. length: 100 charactersThe last name of the user.
Information about the shipping address.
Show properties
Show properties
Max. length: 255 charactersThe first line of the address.
Max. length: 255 charactersThe second line of the address.
Max. length: 255 charactersThe city of the address.
Max. length: 255 charactersThe region of the address. This field is optional except if the
Country
is US, CA, or MX.Max. length: 255 charactersThe postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.
Returned values:
V1
, V2_1
The 3DS protocol version to be applied to the transaction.Returned values:
V1
, V2_1
The 3DS protocol version applied to the transaction.Returned values:
VISA
, MASTERCARD
, CB
, MAESTRO
The card network to use, as chosen by the cardholder, in case of co-branded cards.Information about the card used for the transaction.If the information or data is not available,
null
is returned.Show properties
Show properties
The 6-digit bank identification number (BIN) of the card issuer.
The name of the card issuer.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country where the card was issued.
Returned values:
DEBIT
, CREDIT
, CHARGE CARD
.The type of card product.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.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.Copy
Ask AI
[
{
"Id": "156686696",
"Tag": null,
"CreationDate": 1669116896,
"AuthorId": "156671912",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 500
},
"RemainingFunds": {
"Currency": "EUR",
"Amount": 0
},
"AuthorizationDate": 1669116904,
"Status": "SUCCEEDED",
"PaymentStatus": "VALIDATED",
"ExpirationDate": 1669678504,
"PayInId": "156686722",
"ResultCode": "000000",
"ResultMessage": "Success",
"SecureMode": "FORCE",
"CardId": "156674899",
"SecureModeReturnURL": null,
"SecureModeRedirectURL": null,
"SecureModeNeeded": false,
"PaymentType": "CARD",
"ExecutionType": "DIRECT",
"StatementDescriptor": null,
"Culture": "EN",
"SecurityInfo": null,
"MultiCapture": true,
"BrowserInfo": null,
"IpAddress": null,
"Billing": null,
"Shipping": null,
"Requested3DSVersion": null,
"Applied3DSVersion": null,
"PreferredCardNetwork": null,
"CardInfo": {
"BIN": "497010",
"IssuingBank": "LA BANQUE POSTALE",
"IssuerCountryCode": "MA",
"Type": "CREDIT",
"Brand": "VISA",
"SubType": null
}
}
]
Copy
Ask AI
<?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 {
$userId = 'user_m_01HQK25M6KVHKDV0S36JY9NRKR';
$response = $api->Users->GetPreAuthorizations($userId);
print_r($response);
} catch(MGPResponseException $e) {
print_r($e);
} catch(MGPException $e) {
print_r($e);
}