PAYPAL – Within 3 days as recommended by PayPal, but the technical limit is 29 days (not 29.5).
Note that preauthorizations may not be permitted by some issuers and for some card types.
Best practice - For PayPal, capture funds within 3 daysPayPal recommends that you capture preauthorized funds within 3 days. This is because the success of the capture is subject to risk and the availability of funds on the card (or other funding instrument) that the user has linked to their PayPal account.
Note – Multi-capture not possible with the Deposit PreauthorizationMultiple partial captures are not possible with the Deposit Preauthorization, for either CARD or PAYPAL. In both cases however, the single capture can be for an amount less than the preauthorized amount.
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.
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 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).
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 (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.
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).
Max. length: 255 charactersThe URL to which to redirect the user to proceed to 3DS2 validation.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
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.
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.
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.
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.
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.
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).
Response values: CHALLENGE, FRICTIONLESS, DIRECT_AUTHORIZATIONThe type of authentication:
CHALLENGE – The issuer requested SCA to be enforced (for example, using 3DS).
FRICTIONLESS – The transaction was exempted from SCA because an exemption was granted by the issuer.
DIRECT_AUTHORIZATION – The transaction was sent to the issuer for authorization without any frictionless or challenge (for example, if SCA doesn’t apply).
A null value typically indicates that authentication was not requested (for example, because the request failed before being sent) or a decision was not received.
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.
Default value: falseIf true, sends an email notification to the PaypalBuyerAccountEmail containing the TrackingNumber and Carrier, which allows the end user to track their shipment with the carrier.
Returned values: One of the supported languages in the ISO 639-1 format: AT, BR, CA, CH, CN, DE, DK, ES, FR, GB, ID, IL, IT, JK, JP, NL, NO, PL, PT, RU, SE, TH, TR, TW, US.The language in which the PayPal payment page is to be displayed.
objectInformation about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount (negative amounts not allowed).
Max. length: 127 characters (truncated after)The platform’s unique reference for the seller. This value must be consistently used for the given seller. You can use, for example, the Mangopay UserId or the seller’s business name or first name and last name.
Caution: Failure to use a unique seller identifier may result in PayPal restricting your service.
Allowed values: PHYSICAL_GOODS, DIGITAL_GOODS, DONATIONThe category of the item:
PHYSICAL_GOODS – Tangible items that can be physically shipped and received with proof of delivery upon arrival.
DIGITAL_GOODS – Products or services that are distributed and consumed via digital platforms or devices.
DONATION – Voluntary contribution made without any goods or services received in return. Multiple line items can be categorized as DONATION within a single transaction, however it is not possible to combine DONATION other line item categories within the same transaction.
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.
The URL to which to redirect the user to complete the payment.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
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.
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 (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.
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 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 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.
