Skip to navigation
Card pay-insDeposit Preauthorizations

The Deposit Preauthorized PayIn object

Deprecated

Warning – Deprecated feature

The Deposit Preauthorized PayIn object is deprecated. Use the Extended Preauthorized PayIn object instead.

The Deposit Preauthorization endpoints are scheduled for decommissioning at the end of 2027. Platforms with existing integrations need to move to the new endpoints at their earliest convenience before then.

The Extended Preauthorization feature is a like-for-like renaming of the legacy Deposit Preauthorization – the behavior is otherwise unchanged.

The previous use of the term “deposit” was for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.

Regardless of which endpoint was used to capture the preauthorized funds, the pay-in object returns both the ExtendedPreauthorizationId and the now-deprecated DepositId containing the same unique identifier.

The prefix of the unique identifier allows you to determine the endpoint used to create the preauthorization:

Description

The Deposit Preauthorized PayIn object represents a request to capture funds previously authorized with a Deposit Preauthorization object.

The preauthorized pay-in must:

  • Have the same PaymentType as the deposit preauthorization
  • Be of an amount equal to or less than the preauthorized amount
  • Be captured within 29.5 days of a successful authorization (3 days recommended for PayPal)

Attributes

AuthorIdstringOptional

Default values: The AuthorId of the Deposit Preauthorization object.

The unique identifier of the user at the source of the transaction. On the Deposit Preauthorized PayIn, this parameter returns the same value as the AuthorId of the Deposit Preauthorization object, regardless of the value sent.

CreditedUserIdstringOptional

Default value: The AuthorId of the Deposit Preauthorization object.

The unique identifier of the user whose wallet is credited. On the Deposit Preauthorized PayIn, this parameter returns the same value as the AuthorId of the Deposit Preauthorization object, regardless of the value sent.

CreditedWalletIdstringOptional
The unique identifier of the credited wallet.
ExtendedPreauthorizationIdstringOptional

The unique identifier of the extended preauthorization. The same unique value is also returned in the deprecated DepositId property.

The prefix of the unique identifier determines the endpoint used to create the preauthorization:

DepositIdstringOptional

Deprecated – use ExtendedPreauthorizationId instead.

The unique identifier of the extended preauthorization.

IdstringOptional

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

The unique identifier of the object.

CreationDateintegerOptional

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

ResultCodestringOptional

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestringOptional
The explanation of the result code.
StatusstringOptional

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDateintegerOptional

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

TypestringOptional

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

NaturestringOptional

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction, providing more information about the context in which the transaction occurred:

  • REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
  • REPUDIATION – Automatic withdrawal of funds from the platform's repudiation wallet as part of the dispute process (when the user has requested a chargeback).
  • REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
  • SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.
PaymentTypestringOptional

Returned values: PREAUTHORIZED

The payment type of the pay-in.

ExecutionTypestringOptional

Returned values: DIRECT

The execution type of the pay-in.

DebitedFundsobjectOptional
Information about the debited funds.
CreditedFundsobjectOptional

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

FeesobjectOptional

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

AuthenticationResultobjectOptional

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

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.