Deposit preauthorizations
Create a Deposit Preauthorized PayIn prior to complement
POST
This endpoint allows you to capture the preauthorized funds without closing the preauthorization deposit object. It can be used prior to capturing additional funds with the Create a Deposit Preauthorized PayIn complement endpoint.
Note – Pay-in prior to complement must be full captureThe pay-in requested on this endpoint (prior to complement) must be a full capture of the preauthorized amount - it can’t be partial.
Body parameters
The unique identifier of the user at the source of the transaction.
The unique identifier of the credited wallet.
Information about the debited funds.
Information about the fees.
The unique identifier of the deposit 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.
Responses
200 - Succeeded
200 - Succeeded
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
The unique identifier of the credited wallet.
The unique identifier of the deposit preauthorization.
Max length: 128 characters (see data formats for details)The unique identifier of the object.
The date and time at which the object was created.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Returned values:
CREATED, SUCCEEDED, FAILEDThe status of the transaction.The date and time at which the status changed to
SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.Returned values:
PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.Returned values:
REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
Returned values:
CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.Information about the debited funds.
Information about the credited funds (
CreditedFunds = DebitedFunds - Fees).Information about the fees.
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.
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.
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.
400 - Partial capture not possible
400 - Partial capture not possible
400 - Attempting to capture a canceled deposit
400 - Attempting to capture a canceled deposit