depositPreauthorizations

Create a Deposit Preauthorized PayIn

Changed on
<Warning icon="fa-regular fa-triangle-exclamation"> **Warning – Deprecated feature**

This endpoint is deprecated. Use POST Create an Extended Preauthorized PayIn 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. </Warning>

This endpoint lets you capture funds against a DepositId that was preauthorized on a card or a PayPal account.

The payment method is indicated by the PaymentType of the Deposit Preauthorization object:

  • CARD – Single capture possible within 29.5 days
  • PAYPAL – Single capture recommended within 3 days, but possible up to 29 days (not 29.5)

The shape of the pay-in object is the same – specific data points for card or PayPal authorizations are available via GET View a Deposit Preauthorization.

<Check icon="fa-regular fa-circle-check"> **Best practice - For PayPal, capture funds within 3 days**

PayPal 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. </Check>

post/v2.01/{ClientId}/payins/deposit-preauthorized/direct/full-capture

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/payins/deposit-preauthorized/direct/full-capture
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

Request body

AuthorIdstring required

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

CreditedWalletIdstring required

The unique identifier of the credited wallet.

DepositIdstring required

The unique identifier of the deposit preauthorization.

Tagstring

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

Response

Success

AuthorIdstring

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.

CreditedUserIdstring

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

ExtendedPreauthorizationIdstring

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:

  • ext_auth_wt_<uuid> – POST Create a Card Extended Preauthorization or POST Create a PayPal Extended Preauthorization
  • deposit_wt_<uuid> – POST Create a Card Deposit Preauthorization or POST Create a PayPal Deposit Preauthorization
DepositIdstring

Deprecated – use ExtendedPreauthorizationId instead.

The unique identifier of the extended preauthorization.

Idstring

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

The unique identifier of the object.

CreationDateinteger

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

ResultCodestring

The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.

ResultMessagestring

The explanation of the result code.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDateinteger

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.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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

Returned values: PREAUTHORIZED

The payment type of the pay-in.

ExecutionTypestring

Returned values: DIRECT

The execution type of the pay-in.

Tagstring

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

StatementDescriptorstring

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 <a href="/bank-statements">Customizing bank statement references</a> article for details.

Changes

  • 33a23ba84cddRevision changes
    • info

      endpoint deprecated

    • info

      added the optional property to the response with the status

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API